Skip to content

Commit f240736

Browse files
PierreWangerikaharrison-adsk
authored andcommitted
Change the uppercase letter "S" in "screenSpace" to lowercase.
1 parent 10d9ae0 commit f240736

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

proposals/LineStyle/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -51,9 +51,9 @@ The DashDotLines has the following new properties:
5151
- startCapType. A token uniform. It is the shape of the line cap at the start of the line. It can be "round", "triangle" or "square". The default value is "round".
5252
- endCapType. A token uniform. It is the shape of the line cap at the end of the line. It can be "round", "triangle" or "square". The default value is "round".
5353
- patternScale. A float uniform. It is valid when the primitive binds a DashDotPattern. The default value is 1. You can lengthen or compress the line pattern by setting this property. For example, if patternScale is set to 2, the length of each dash and each gap will be enlarged by 2 times. This value will not impact on the line width.
54-
- screenSpacePattern. A bool uniform. It is valid when the primitive binds a DashDotPattern. By default it is true, which means the dash-dot pattern will be based on screen unit. If we zoom in, the pattern on the line will change in the world space, so that the dash size and the dash gap size in the screen space will not change. If it is false, the pattern will be based on world unit. If we zoom in, the pattern on the line will not change in world space. The dash size and the dash gap size in the screen space will be larger.
54+
- screenspacePattern. A bool uniform. It is valid when the primitive binds a DashDotPattern. By default it is true, which means the dash-dot pattern will be based on screen unit. If we zoom in, the pattern on the line will change in the world space, so that the dash size and the dash gap size in the screen space will not change. If it is false, the pattern will be based on world unit. If we zoom in, the pattern on the line will not change in world space. The dash size and the dash gap size in the screen space will be larger.
5555

56-
![image of screenSpacePattern](screenSpacePattern.png)
56+
![image of screenspacePattern](screenSpacePattern.png)
5757

5858
### Extents of the DashDotLines
5959
Different from the other Curves, the extents of the DashDotLines is only the bound box of the control points. The width of the line will not be considered, because it is screen spaced, that it is implemented via the shader.
@@ -70,7 +70,7 @@ For example, assume the pattern is [(0, 10), (1, 4), (3, 0)]. It means the first
7070
An API schema DashDotPatternAPI is provided to bind the DashDotPattern to a DashDotLines primitive.
7171

7272
### The DashDotLines rprim and shader
73-
In HdStorm, we will add the HdDashDotLines rprim for the DashDotLines primitive. The topology of the DashDotLines requires the curveVertexCounts, curveIndices and whether the pattern is screenSpaced. In dashDotLines.glslfx, we add two sections of shader code: "DashDot.Vertex" and "DashDot.Fragment".
73+
In HdStorm, we will add the HdDashDotLines rprim for the DashDotLines primitive. The topology of the DashDotLines requires the curveVertexCounts, curveIndices and whether the pattern is screenspaced. In dashDotLines.glslfx, we add two sections of shader code: "DashDot.Vertex" and "DashDot.Fragment".
7474

7575
### Other inputs for the shader and screen space pattern implementation
7676
For a polyline, the shader need to know the sum of line lengths before each vertex. This value can be pre-calculated in CPU. To implement screen space dash-dot pattern, the sum must be based on line lengths on the screen. So to calculate the sum, we need to do matrix transformation for the lines in CPU, and this calculation must be done when camera is changed. (Maybe we can use the compute shader to do the calculation before the rendering process in each frame)
@@ -81,7 +81,7 @@ For a polyline, the shader need to know the sum of line lengths before each vert
8181
def DashDotLines "StyledPolyline1" (
8282
prepend apiSchemas = ["DashDotPatternAPI"]
8383
){
84-
uniform bool screenSpacePattern = true
84+
uniform bool screenspacePattern = true
8585
rel dashDotPattern:binding = </Pattern>
8686
uniform token startCapType = "round"
8787
uniform token endCapType = "round"
@@ -94,7 +94,7 @@ def DashDotLines "StyledPolyline1" (
9494
def DashDotLines "StyledPolyline2" (
9595
prepend apiSchemas = ["DashDotPatternAPI"]
9696
){
97-
uniform bool screenSpacePattern = true
97+
uniform bool screenspacePattern = true
9898
rel dashDotPattern:binding = </Pattern>
9999
uniform token startCapType = "triangle"
100100
uniform token endCapType = "triangle"

0 commit comments

Comments
 (0)