Click or drag to resize
SoLineSet Class

Polyline shape node.

Inheritance Hierarchy

Namespace: OIV.Inventor.Nodes
Assembly: OIV.Inventor (in OIV.Inventor.dll) Version: 10.12.3.0 (10.12.3.0)
Syntax
public class SoLineSet : SoNonIndexedShape

The SoLineSet type exposes the following members.

Constructors
  NameDescription
Public methodSoLineSet

Creates a line set node with default settings.

Top
Methods
  NameDescription
Public methodAffectsState

Overrides default method on OIV.Inventor.Nodes.SoNode.

(Inherited from SoShape.)
Public methodBeginShape(SoAction, SoShapeTriangleShapes)
Calls BeginShape(action, shapeType, (OIV.Inventor.Details.SoFaceDetail ^)nullptr).
(Inherited from SoShape.)
Public methodBeginShape(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.

(Inherited from SoShape.)
Public methodCallback

Implements primitive generation for all shapes.

(Inherited from SoShape.)
Public methodComputeBBox(SoAction, SbBox3f, SbVec3f)

This handles AABB bounding box computation for all shapes derived from this class.

(Inherited from SoNonIndexedShape.)
Public methodComputeBBox(SoAction, SbXfBox3d, SbVec3d)

This handles OOBB bounding box computation for all shapes derived from this class.

(Inherited from SoNonIndexedShape.)
Public methodCopy
Calls Copy(false).
(Inherited from SoNode.)
Public methodCopy(Boolean)

Creates and returns an exact copy of the node.

(Inherited from SoNode.)
Public methodCopyFieldValues(SoFieldContainer)
Calls CopyFieldValues(fc, false).
(Inherited from SoFieldContainer.)
Public methodCopyFieldValues(SoFieldContainer, Boolean)

Copies the contents of fc's fields into this object's fields.

(Inherited from SoFieldContainer.)
Public methodDispose
Releases all resources used by SoDisposable.
(Inherited from SoDisposable.)
Public methodDistribute
(Inherited from SoNode.)
Public methodDoAction
(Inherited from SoNode.)
Public methodEnableNotify

Notification at this Field Container is enabled (if flag == true) or disabled (if flag == false).

(Inherited from SoFieldContainer.)
Public methodEndShape

end shape previously started with OIV.Inventor.Nodes.SoShape.BeginShape(OIV.Inventor.Actions.SoAction, OIV.Inventor.Nodes.SoShape.TriangleShapes, OIV.Inventor.Details.SoFaceDetail).

(Inherited from SoShape.)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodFieldsAreEqual

Returns true if this object's fields are exactly equal to fc's fields.

(Inherited from SoFieldContainer.)
Public methodGet

Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string.

(Inherited from SoFieldContainer.)
Public methodGetAllFields

Returns a list of fields, including the eventIn's and eventOut's.

(Inherited from SoFieldContainer.)
Public methodGetAlternateRep

This method is called by actions to allow the node to provide an "alternate representation" when appropriate (typically depending on the action type).

(Inherited from SoNode.)
Public methodGetBoundingBox

Implements getBoundingBox actions to tell open caches that they contain lines.

(Overrides SoShapeGetBoundingBox(SoGetBoundingBoxAction).)
Public methodGetEventIn

Returns a the eventIn with the given name.

(Inherited from SoFieldContainer.)
Public methodGetEventOut

Returns the eventOut with the given name.

(Inherited from SoFieldContainer.)
Public methodGetField

Returns a the field of this object whose name is fieldName.

(Inherited from SoFieldContainer.)
Public methodGetFieldName

Returns the name of the given field in the fieldName argument.

(Inherited from SoFieldContainer.)
Public methodGetFields

Appends references to all of this object's fields to resultList, and returns the number of fields appended.

(Inherited from SoFieldContainer.)
Public methodGetHashCode
Overrides GetHashCode().
(Inherited from SoNetBase.)
Public methodGetMatrix
(Inherited from SoNode.)
Public methodGetName

Returns the name of an instance.

(Inherited from SoBase.)
Public methodGetNormalCache

Returns the current normal cache, or NULL if there is none.

(Inherited from SoVertexShape.)
Public methodGetPrimitiveCount (Overrides SoShapeGetPrimitiveCount(SoGetPrimitiveCountAction).)
Public methodGetRenderEngineMode

Returns the supported Render engine mode.

(Inherited from SoNode.)
Public methodGetRenderUnitID
(Inherited from SoNode.)
Public methodGetShapeType

Gets the current shape Full Scene Antialiasing type.

(Inherited from SoShape.)
Public methodGetStringName (Inherited from SoBase.)
Public methodGetTangentCache

Returns the current tangent cache, or NULL if there is none.

(Inherited from SoVertexShape.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGLRender (Overrides SoVertexShapeGLRender(SoGLRenderAction).)
Public methodGLRenderBelowPath
(Inherited from SoNode.)
Public methodGLRenderInPath
(Inherited from SoNode.)
Public methodGLRenderOffPath
(Inherited from SoNode.)
Public methodGrabEventsCleanup
(Inherited from SoNode.)
Public methodGrabEventsSetup
(Inherited from SoNode.)
Public methodHandleEvent
(Inherited from SoNode.)
Public methodHasDefaultValues

Returns true if all of the object's fields have their default values.

(Inherited from SoFieldContainer.)
Public methodIsBoundingBoxIgnoring

Used by BoundingBoxAction to know if bounding box computation should be ignored or not.

(Inherited from SoShape.)
Public methodIsNotifyEnabled

Notification is the process of telling interested objects that this object has changed.

(Inherited from SoFieldContainer.)
Public methodIsOverride

Returns the state of the override flag.

(Inherited from SoNode.)
Public methodIsSynchronizable

Gets the ScaleViz synchronizable state of this object.

(Inherited from SoBase.)
Public methodPick
(Inherited from SoNode.)
Public methodRayPick

Implements picking along a ray by intersecting the ray with each primitive generated by subclass.

(Inherited from SoShape.)
Public methodSearch
(Inherited from SoNode.)
Public methodSet

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.

(Inherited from SoFieldContainer.)
Public methodSetName (Inherited from SoBase.)
Public methodSetOverride

Turns the override flag on or off.

(Inherited from SoNode.)
Public methodSetShapeType

set the antialiasing type for this shape.

(Inherited from SoShape.)
Public methodSetSynchronizable

Sets this to be a ScaleViz synchronizable object.

(Inherited from SoBase.)
Public methodSetToDefaults

Sets all fields in this object to their default values.

(Inherited from SoFieldContainer.)
Public methodShapeVertex

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).

(Inherited from SoShape.)
Public methodToString
Converts this SoBase structure to a human readable string.
(Inherited from SoBase.)
Public methodTouch

Marks an instance as modified, simulating a change to it.

(Inherited from SoNode.)
Public methodWrite
(Inherited from SoVertexShape.)
Top
Properties
  NameDescription
Public propertyboundingBoxIgnoring

Whether to ignore this node during bounding box traversal.

(Inherited from SoShape.)
Public propertyIsDisposable
ISafeDisposable interface implementation.
(Inherited from SoDisposable.)
Public propertynumVertices

Number of vertices per polyline.

Public propertystartIndex

Index of first coordinate of shape.

(Inherited from SoNonIndexedShape.)
Public propertyUserData
Gets or sets the user data to be contained by the field container.
(Inherited from SoFieldContainer.)
Public propertyvertexProperty

vertex property node.

(Inherited from SoVertexShape.)
Top
Remarks

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:

FILE FORMAT/DEFAULT

LineSet {
vertexProperty NULL
startIndex 0
numVertices -1
}

ACTION BEHAVIOR

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.

See Also