SoLineSet Class |
Polyline shape node.
Namespace: OIV.Inventor.Nodes
The SoLineSet type exposes the following members.
Name | Description | |
---|---|---|
AffectsState | Overrides default method on OIV.Inventor.Nodes.SoNode. | |
BeginShape(SoAction, SoShapeTriangleShapes) | Calls BeginShape(action, shapeType, (OIV.Inventor.Details.SoFaceDetail ^)nullptr). (Inherited from SoShape.) | |
BeginShape(SoAction, SoShapeTriangleShapes, SoFaceDetail) | These methods can be used by subclasses to generate triangles more easily when those triangles are part of a larger structure, such as a triangle strip, triangle fan, or triangulated polygon, according to the TriangleShape enumerated type. | |
Callback | Implements primitive generation for all shapes. | |
ComputeBBox(SoAction, SbBox3f, SbVec3f) | This handles AABB bounding box computation for all shapes derived from this class. | |
ComputeBBox(SoAction, SbXfBox3d, SbVec3d) | This handles OOBB bounding box computation for all shapes derived from this class. | |
Copy | Calls Copy(false). (Inherited from SoNode.) | |
Copy(Boolean) | Creates and returns an exact copy of the node. | |
CopyFieldValues(SoFieldContainer) | Calls CopyFieldValues(fc, false). (Inherited from SoFieldContainer.) | |
CopyFieldValues(SoFieldContainer, Boolean) | Copies the contents of fc's fields into this object's fields. | |
Dispose |
Releases all resources used by SoDisposable.
(Inherited from SoDisposable.) | |
Distribute | (Inherited from SoNode.) | |
DoAction | (Inherited from SoNode.) | |
EnableNotify | Notification at this Field Container is enabled (if flag == true) or disabled (if flag == false). | |
EndShape | end shape previously started with OIV.Inventor.Nodes.SoShape.BeginShape(OIV.Inventor.Actions.SoAction, OIV.Inventor.Nodes.SoShape.TriangleShapes, OIV.Inventor.Details.SoFaceDetail). | |
Equals | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) | |
FieldsAreEqual | Returns true if this object's fields are exactly equal to fc's fields. | |
Get | Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string. | |
GetAllFields | Returns a list of fields, including the eventIn's and eventOut's. | |
GetAlternateRep | This method is called by actions to allow the node to provide an "alternate representation" when appropriate (typically depending on the action type). | |
GetBoundingBox | Implements getBoundingBox actions to tell open caches that they contain lines. | |
GetEventIn | Returns a the eventIn with the given name. | |
GetEventOut | Returns the eventOut with the given name. | |
GetField | Returns a the field of this object whose name is fieldName. | |
GetFieldName | Returns the name of the given field in the fieldName argument. | |
GetFields | Appends references to all of this object's fields to resultList, and returns the number of fields appended. | |
GetHashCode |
Overrides GetHashCode().
(Inherited from SoNetBase.) | |
GetMatrix | (Inherited from SoNode.) | |
GetName | Returns the name of an instance. | |
GetNormalCache | Returns the current normal cache, or NULL if there is none. | |
GetPrimitiveCount | Implements OIV.Inventor.Actions.SoGetPrimitiveCountAction action. | |
GetRenderEngineMode | Returns the supported Render engine mode. | |
GetRenderUnitID | (Inherited from SoNode.) | |
GetShapeType | Gets the current shape Full Scene Antialiasing type. | |
GetStringName | (Inherited from SoBase.) | |
GetTangentCache | Returns the current tangent cache, or NULL if there is none. | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
GLRender | Implements OIV.Inventor.Actions.SoGLRenderAction actions. | |
GLRenderBelowPath | (Inherited from SoNode.) | |
GLRenderInPath | (Inherited from SoNode.) | |
GLRenderOffPath | (Inherited from SoNode.) | |
GrabEventsCleanup | (Inherited from SoNode.) | |
GrabEventsSetup | (Inherited from SoNode.) | |
HandleEvent | (Inherited from SoNode.) | |
HasDefaultValues | Returns true if all of the object's fields have their default values. | |
IsBoundingBoxIgnoring | Used by BoundingBoxAction to know if bounding box computation should be ignored or not. | |
IsNotifyEnabled | Notification is the process of telling interested objects that this object has changed. | |
IsOverride | Returns the state of the override flag. | |
IsSynchronizable | Gets the ScaleViz synchronizable state of this object. | |
Pick | (Inherited from SoNode.) | |
RayPick | Implements picking along a ray by intersecting the ray with each primitive generated by subclass. | |
Search | (Inherited from SoNode.) | |
Set | Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format. | |
SetName | (Inherited from SoBase.) | |
SetOverride | Turns the override flag on or off. | |
SetShapeType | set the antialiasing type for this shape. | |
SetSynchronizable | Sets this to be a ScaleViz synchronizable object. | |
SetToDefaults | Sets all fields in this object to their default values. | |
ShapeVertex | add a primitive vertex to the shape prevously started with OIV.Inventor.Nodes.SoShape.BeginShape(OIV.Inventor.Actions.SoAction, OIV.Inventor.Nodes.SoShape.TriangleShapes, OIV.Inventor.Details.SoFaceDetail). | |
ToString |
Converts this SoBase structure to a human readable string.
(Inherited from SoBase.) | |
Touch | Marks an instance as modified, simulating a change to it. | |
Write | (Inherited from SoVertexShape.) |
Name | Description | |
---|---|---|
boundingBoxIgnoring | Whether to ignore this node during bounding box traversal. | |
IsDisposable | ISafeDisposable interface implementation.
(Inherited from SoDisposable.) | |
numVertices | Number of vertices per polyline. | |
startIndex | Index of first coordinate of shape. | |
UserData |
Gets or sets the user data to be contained by the field container.
(Inherited from SoFieldContainer.) | |
vertexProperty | vertex property node. |
This node represents a 3D shape formed by constructing a set of polylines from vertices located at the coordinates specified in the vertexProperty field (from OIV.Inventor.Nodes.SoVertexShape), or the current inherited coordinates. For optimal performance, the vertexProperty field is recommended.
Coordinates are used in order, starting with startIndex (zero by default).
If the OIV.Inventor.Nodes.SoLineSet.numVertices field contains -1 (the default), then all the coordinates (starting with startIndex) are rendered as a single polyline.
Otherwise each polyline uses the number of vertices specified by a value in the OIV.Inventor.Nodes.SoLineSet.numVertices field. For example, an OIV.Inventor.Nodes.SoLineSet with a OIV.Inventor.Nodes.SoLineSet.numVertices of [3,4,2] would use the first three coordinates for the first polyline, the next four coordinates for the second polyline, and the next two coordinates for the third polyline. Thus the number of values in the OIV.Inventor.Nodes.SoLineSet.numVertices field indicates the number of polylines in the set.
The coordinates of the line set are transformed by the current cumulative transformation.
The line width and pattern are controlled by fields in OIV.Inventor.Nodes.SoDrawStyle.
The lines are drawn with the current drawing style (see OIV.Inventor.Nodes.SoDrawStyle), but drawing style FILLED is treated as LINES.
Treatment of the current material, normal and tangent binding is as follows:
PER_PART binding specifies a material, normal or tangent for each segment of the line.
PER_FACE binding specifies a material, normal or tangent for each polyline.
PER_VERTEX specifies a material, normal or tangent for each vertex.
The _INDEXED bindings mean exactly the same as their non-indexed counterparts.
The default material binding is OVERALL.
The default normal and tangent bindings are PER_VERTEX
The current complexity value has no effect on the rendering of line sets.
Shape Antialiasing type is OIV.Inventor.Nodes.SoShape.ShapeTypes.LINES.
Lighting:
By default, lighting is enabled (OIV.Inventor.Nodes.SoLightModel model = PER_VERTEX_PHONG). But... Unlike polygonal shapes, lighting will not be applied to line shapes unless the application explicitly sets normal vectors (using OIV.Inventor.Nodes.SoVertexProperty or OIV.Inventor.Nodes.SoNormal) or sets tangent vectors (using OIV.Inventor.Nodes.SoVertexProperty). Normal vectors are not automatically computed for line shapes.
If lighting is enabled and tangent vectors are specified: then normal vectors are ignored and lines are lighted using the Illuminated Stream Lines algorithm (Zöckler, Stalling & Hege, 1996) (http://www.zib.de/visual-publications/sources/src-1996/isl.pdf).
If lighting is enabled and normal vectors are specified but not tangent vectors: then lines are lighted using the same algorithm as polygonal shapes.
Note the above discussion is specific to rendering of line shapes , e.g. this node. If you render a polygonal shape, e.g. OIV.Inventor.Nodes.SoFaceSet, using LINES mode (OIV.Inventor.Nodes.SoDrawStyle), the rules for polygonal shapes apply (if lighting is enabled and no normal vectors were specified, then normal vectors are automatically computed by Open Inventor).
NOTE: If you want to apply lighting in a shader, you must explicitly set normal or tangent vectors, otherwise lighting will be disabled for the line shape.
Limitations:
Currently does not use VBOs (vertex buffer objects) for rendering. For very large line sets, performance may be better using OIV.Inventor.Nodes.SoIndexedLineSet.
LineSet {
vertexProperty | NULL |
startIndex | 0 |
numVertices | -1 |
OIV.Inventor.Actions.SoGLRenderAction Draws lines based on the current coordinates, normals, tangents, materials, drawing style, and so on.
OIV.Inventor.Actions.SoRayPickAction Picks lines based on the current coordinates and transformation. Details about the intersection are returned in an OIV.Inventor.Details.SoLineDetail.
OIV.Inventor.Actions.SoGetBoundingBoxAction Computes the bounding box that encloses all vertices of the line set with the current transformation applied to them. Sets the center to the average of the coordinates of all vertices.
OIV.Inventor.Actions.SoCallbackAction If any line segment callbacks are registered with the action, they will be invoked for each successive segment in the line set.