Click or drag to resize
SoVRMLIndexedLineSet Class

Note: This API is now obsolete.

Indexed polyline shape node.

Inheritance Hierarchy

Namespace: OIV.Inventor.VRMLnodes
Assembly: OIV.Inventor (in OIV.Inventor.dll) Version: 9.9.13.0 (9.9.13.0)
Syntax
[ObsoleteAttribute("See documentation for more details")]
[EditorBrowsableAttribute(EditorBrowsableState.Never)]
public class SoVRMLIndexedLineSet : SoVRMLIndexedLine

The SoVRMLIndexedLineSet type exposes the following members.

Constructors
  NameDescription
Public methodSoVRMLIndexedLineSet

Constructor.

Top
Methods
  NameDescription
Public methodAffectsState

Overrides default method on 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 methodCallShouldGLRender Obsolete.
Calls CallShouldGLRender(action, false).
(Inherited from SoShape.)
Public methodComputeBBox(SoAction, SbXfBox3d, SbVec3d)

Compute object oriented bounding box (OOB) for subclass using information in the given action (which may not necessarily be an SoGetBoundingBoxAction).

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

Compute axis aligned bounding box (AABB) for subclass using information in the given action (which may not necessarily be an SoGetBoundingBoxAction).

(Inherited from SoVRMLIndexedLine.)
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 beginShape().

(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 methodGeneratePick
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 bounding box method using virtual computeBBox() method.

(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 methodGetPrimitiveCount

Counts number of primitives produced by this shape.

(Overrides SoShapeGetPrimitiveCount(SoGetPrimitiveCountAction).)
Public methodGetRenderUnitID
(Inherited from SoNode.)
Public methodGetShapeType

Gets the current shape Full Scene Antialiasing type.

(Inherited from SoShape.)
Public methodGetStringName (Inherited from SoBase.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGLRender

Implements rendering by rendering each primitive generated by subclass.

(Overrides SoShapeGLRender(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 methodHandleInvisibleOrBBox Obsolete.
Calls HandleInvisibleOrBBox(action, false).
(Inherited from SoShape.)
Public methodHasDefaultValues

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

(Inherited from SoFieldContainer.)
Public methodIsBoundingBoxIgnoring

This method is used by getBoundingBox action traversal to know if the current node must be traversed or not, ie the bounding should be ignored.

(Inherited from SoNode.)
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 methodIsTransparent
(Inherited from SoVRMLGeometry.)
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 beginShape().

(Inherited from SoShape.)
Public methodShouldGLRender Obsolete.
Calls ShouldGLRender(action, false).
(Inherited from SoVRMLGeometry.)
Public methodShouldGLRenderCore(SoGLRenderAction) Obsolete.
Calls ShouldGLRenderCore(action, false, false).
(Inherited from SoShape.)
Public methodShouldGLRenderCore(SoGLRenderAction, Boolean) Obsolete.
Calls ShouldGLRenderCore(action, isPointsOrLines, false).
(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 SoNode.)
Top
Properties
  NameDescription
Public propertyboundingBoxIgnoring

Whether to ignore this node during bounding box traversal.

(Inherited from SoShape.)
Public propertycolor

An SoVRMLColor node whose colors are applied to the vertices or lines of the IndexedLineSet.

(Inherited from SoVRMLVertexLine.)
Public propertycolorIndex

The indices of the colors to use for the lines or vertices depending on the value of the colorPerVertex field.

(Inherited from SoVRMLIndexedLine.)
Public propertycolorPerVertex

If true, colors are applied to the vertices of the IndexedLineSet.

(Inherited from SoVRMLVertexLine.)
Public propertycoord

An SoVRMLCoordinate node defining the IndexedLineSet.

(Inherited from SoVRMLVertexLine.)
Public propertycoordIndex

Indices of the coordinates that the indexed line set uses as its vertices.

(Inherited from SoVRMLIndexedLine.)
Public propertyIsDisposable
ISafeDisposable interface implementation.
(Inherited from SoDisposable.)
Public propertymetadata

Specifies the metadata node.

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

See the VRML97 Specification, below.

<font color="#0000FF">NOTE:</font> This class does not exist in Open Inventor 10.0 and later.

VRML97 SPECIFICATION

This section describes the expected behavior of the node in a conforming VRML97 browser application. In some cases, the application is responsible for implementing portions of the expected behavior. Open Inventor viewer classes and IVF classes implement some of the application behaviors.

This section may reference portions of the VRML97 specification that are not present in this help file. The complete VRML97 spec is available at http://www.web3d.org.

The SoVRMLIndexedLineSet node represents a 3D geometry formed by constructing polylines from 3D points specified in the coord field. SoVRMLIndexedLineSet uses the indices in its coordIndex field to specify the polylines by connecting together points from the coord field. An index of -1 indicates that the current polyline has ended and the next one begins. The last polyline may (but does not have to be) followed by a -1. SoVRMLIndexedLineSet is specified in the local coordinate system and is affected by parent transformations.

The coord field specifies the 3D vertices of the line set and is specified by an SoVRMLCoordinate node.

Lines are not lit, not texture-mapped, or not collided with during collision detection.

If the color field is not NULL, it must contain an SoVRMLColor node, and the colors are applied to the line(s) as follows:

  • If colorPerVertex is false:

  • If the colorIndex field is not empty, then one color is used for each polyline of the SoVRMLIndexedLineSet. There must be at least as many indices in the colorIndex field as there are polylines in the SoVRMLIndexedLineSet. If the greatest index in the colorIndex field is N, then there must be N+1 colors in the SoVRMLColor node. The colorIndex field must not contain any negative entries.

  • If the colorIndex field is empty, then the colors are applied to each polyline of the SoVRMLIndexedLineSet in order. There must be at least as many colors in the SoVRMLColor node as there are polylines.

  • If colorPerVertex is true:

  • If the colorIndex field is not empty, then colors are applied to each vertex of the SoVRMLIndexedLineSet in exactly the same manner that the coordIndex field is used to supply coordinates for each vertex from the SoVRMLCoordinate node. The colorIndex field must contain at least as many indices as the coordIndex field and must contain end-of-polyline markers (-1) in exactly the same places as the coordIndex field. If the greatest index in the colorIndex field is N, then there must be N+1 colors in the SoVRMLColor node.

  • If the colorIndex field is empty, then the coordIndex field is used to choose colors from the SoVRMLColor node. If the greatest index in the coordIndex field is N, then there must be N+1 colors in the SoVRMLColor node.

If the color field is NULL and there is a Material defined for the SoVRMLAppearance affecting this IndexedLineSet, then use the emissiveColor of the Material to draw the lines. See "Concepts - Lighting Model, Lighting Off" for details on lighting equations.

Shape Antialiasing type is SoShape.LINES.

FILE FORMAT/DEFAULT

VRMLIndexedLineSet {
color NULL
colorIndex []
colorPerVertex true
coord NULL
coordIndex []
metadata NULL
}

ACTION BEHAVIOR

SoGLRenderAction, SoRayPickAction, SoGetBoundingBoxAction, SoCallbackAction

EVENTS

eventIn

SoSFNodeset_color
SoMFInt32set_colorIndex
SoSFNodeset_coord
SoMFInt32set_coordIndex
SoSFNodeset_metadata

eventOut

SoSFNodecolor_changed
SoSFNodecoord_changed
SoSFNodemetadata_changed
Obsoletesince Open Inventor 9500 The VRML API is no longer supported. See section http://oivdoc95.vsg3d.com/content/compatibility-notes-4#Deprecation of the Reference Manual.

See Also