H3D::IndexedLineSet Class Reference
[X3D node classes.]

The IndexedLineSet node represents a 3D geometry formed by constructing polylines from 3D vertices specified in the coord field. More...

#include <IndexedLineSet.h>

Inheritance diagram for H3D::IndexedLineSet:

List of all members.

Public Types
typedef DependentSFNode< X3DCoordinateNode, FieldRef< X3DGeometricPropertyNode, Field,&X3DCoordinateNode::propertyChanged > >	SFCoordinateNode
	SFCoordinateNode is dependent on coordChanged field in X3DCoordinateNode.
typedef DependentSFNode< X3DColorNode, FieldRef< X3DGeometricPropertyNode, Field,&X3DColorNode::propertyChanged > >	SFColorNode
	SFColorNode is dependent on colorChanged field in X3DColorNode.
Public Member Functions
	H3D_VALUE_EXCEPTION (int, InvalidColorIndex)
	Thrown when the colorIndex field does not match the coordIndex field properly.
	H3D_VALUE_EXCEPTION (int, InvalidColorIndexSize)
	Thrown when the colorIndex field's size does not match the coordIndex field properly.
	IndexedLineSet (Inst< SFNode > _metadata=0, Inst< CoordBoundField > _bound=0, Inst< DisplayList > _displayList=0, Inst< MFInt32 > _set_colorIndex=0, Inst< MFInt32 > _set_coordIndex=0, Inst< SFColorNode > _color=0, Inst< SFCoordinateNode > _coord=0, Inst< MFInt32 > _colorIndex=0, Inst< SFBool > _colorPerVertex=0, Inst< MFInt32 > _coordIndex=0)
	Constructor.
virtual void	render ()
	Render the IndexedLineSet with OpenGL.
Public Attributes
auto_ptr< MFInt32 >	set_colorIndex
	Field for setting the value of the colorIndex field.
auto_ptr< MFInt32 >	set_coordIndex
	Field for setting the value of the coordIndex field.
auto_ptr< SFColorNode >	color
	Contains an X3DColorNode which colors are applied to the X3DComposedGeometryNode.
auto_ptr< SFCoordinateNode >	coord
	The coord field specifies the 3D vertices of the line set and contains a X3DCoordinateNode.
auto_ptr< MFInt32 >	colorIndex
	Indices into the color field.
auto_ptr< SFBool >	colorPerVertex
	If TRUE the colors in the color field are applied per vertex, otherwise it is applied per polyline.
auto_ptr< MFInt32 >	coordIndex
	Indices into the coord field.
Static Public Attributes
static H3DNodeDatabase	database
	The H3DNodeDatabase instance for this node.

---

Detailed Description

The IndexedLineSet node represents a 3D geometry formed by constructing polylines from 3D vertices specified in the coord field.

IndexedLineSet uses the indices in its coordIndex field to specify the polylines by connecting vertices from the coord field. An index of "-1" indicates that the current polyline has ended and the next one begins. The last polyline may be (but does not have to be) followed by a "-1". IndexedLineSet is specified in the local coordinate system and is affected by the transformations of its ancestors.

The coord field specifies the 3D vertices of the line set and contains a X3DCoordinateNode.

Lines are not lit, are not texture-mapped, and do not participate in collision detection. The width of lines is implementation dependent and each line segment is solid (i.e., not dashed).

If the color field is not NULL, it shall contain a Color node. The colours are applied to the line(s) as follows:

• If colorPerVertex is FALSE:
  1. If the colorIndex field is not empty, one colour is used for each polyline of the IndexedLineSet. There shall be at least as many indices in the colorIndex field as there are polylines in the IndexedLineSet. If the greatest index in the colorIndex field is N, there shall be N+1 colours in the Color node. The colorIndex field shall not contain any negative entries.
  2. If the colorIndex field is empty, the colours from the Color node are applied to each polyline of the IndexedLineSet in order. There shall be at least as many colours in the Color node as there are polylines.

• If colorPerVertex is TRUE:
  1. If the colorIndex field is not empty, colours are applied to each vertex of the IndexedLineSet in exactly the same manner that the coordIndex field is used to supply coordinates for each vertex from the Coordinate node. The colorIndex field shall contain at least as many indices as the coordIndex field and shall 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, there shall be N+1 colours in the Color node.
  2. If the colorIndex field is empty, the coordIndex field is used to choose colours from the Color node. If the greatest index in the coordIndex field is N, there shall be N+1 colours in the Color node.

If the color field is NULL and there is a Material defined for the Appearance affecting this IndexedLineSet, the emissiveColor of the Material shall be used to draw the lines.

Internal routes:

---

Member Data Documentation

auto_ptr< SFColorNode > H3D::IndexedLineSet::color

Contains an X3DColorNode which colors are applied to the X3DComposedGeometryNode. If the color field is NULL and there is a Material defined for the Appearance affecting this IndexedLineSet, the emissiveColor of the Material shall be used to draw the lines. If a color is not NULL colors are applied as described in the detailed description Access type: inputOutput

auto_ptr< MFInt32 > H3D::IndexedLineSet::colorIndex

Indices into the color field. See Detailed description for details on how it is used. Access type: inputOutput Value range: [0,inf) or -1

auto_ptr< SFBool > H3D::IndexedLineSet::colorPerVertex

If TRUE the colors in the color field are applied per vertex, otherwise it is applied per polyline. Access type: inputOutput Default value: TRUE

auto_ptr< SFCoordinateNode > H3D::IndexedLineSet::coord

The coord field specifies the 3D vertices of the line set and contains a X3DCoordinateNode. Access type: inputOutput

auto_ptr< MFInt32 > H3D::IndexedLineSet::coordIndex

Indices into the coord field. See Detailed description for details on how it is used. Access type: inputOutput Value range: [0,inf) or -1

auto_ptr< MFInt32 > H3D::IndexedLineSet::set_colorIndex

Field for setting the value of the colorIndex field. Access type: inputOnly

auto_ptr< MFInt32 > H3D::IndexedLineSet::set_coordIndex

Field for setting the value of the coordIndex field. Access type: inputOnly

---