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

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

#include <H3D/LineSet.h>

Inheritance diagram for H3D::LineSet:

Inheritance graph

List of all members.

Classes

class  InvalidVertexCountValue
 Thrown then vertexCount value is < 2. More...

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.
typedef DependentSFNode
< FogCoordinate, FieldRef
< X3DGeometricPropertyNode,
Field,&FogCoordinate::propertyChanged > > 
SFFogCoordinate
 The SFFogCoordinate is dependent on the propertyChanged field of the contained FogCoordinate.
typedef CoordBoundField SFBound
 The bound field for LineSet is a CoordBoundField.

Public Member Functions

 LineSet (Inst< SFNode > _metadata=0, Inst< SFBound > _bound=0, Inst< DisplayList > _displayList=0, Inst< SFColorNode > _color=0, Inst< SFCoordinateNode > _coord=0, Inst< MFInt32 > _vertexCount=0, Inst< SFFogCoordinate > _fogCoord=0)
 Constructor.
virtual int nrLines ()
 The number of lines rendered by this geometry.
virtual void render ()
 Render the LineSet with OpenGL.

Public Attributes

auto_ptr< SFColorNodecolor
 The color field specifies the colour of the line set at each vertex and contains a X3DColorNode.
auto_ptr< SFCoordinateNodecoord
 The coord field specifies the 3D vertices of the line set and contains a X3DCoordinateNode.
auto_ptr< MFInt32vertexCount
 The vertexCount field describes how many vertices are to be used in each polyline from the coordinate field.
auto_ptr< SFFogCoordinatefogCoord
 If the fogCoord field is not empty, it shall contain a list of per-vertex depth values for calculating fog depth.

Static Public Attributes

static H3DNodeDatabase database
 The H3DNodeDatabase for this node.


Detailed Description

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

The color field specifies the colour of the line set at each vertex and contains a X3DColorNode. If the color field is NULL and there is a Material defined for the Appearance affecting this LineSet, the emissiveColor of the Material shall be used to draw the lines.

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

The vertexCount field describes how many vertices are to be used in each polyline from the coordinate field. Coordinates are assigned to each line by taking vertexCount[n] vertices from the coordinate field. Each value of the vertexCount array shall be greater than or equal to two. It shall be an error to have a value less than two.

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

Internal routes:
LineSet.dot

Member Typedef Documentation

SFColorNode is dependent on colorChanged field in X3DColorNode.

SFCoordinateNode is dependent on coordChanged field in X3DCoordinateNode.

The SFFogCoordinate is dependent on the propertyChanged field of the contained FogCoordinate.


Member Data Documentation

The color field specifies the colour of the line set at each vertex and contains a X3DColorNode.

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

Access type: inputOutput

LineSet_color.dot

Referenced by LineSet(), and render().

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

Access type: inputOutput

LineSet_coord.dot

Referenced by LineSet(), and render().

If the fogCoord field is not empty, it shall contain a list of per-vertex depth values for calculating fog depth.

Access type: inputOutput

LineSet_fogCoord.dot

Referenced by LineSet(), and render().

The vertexCount field describes how many vertices are to be used in each polyline from the coordinate field.

Coordinates are assigned to each line by taking vertexCount[n] vertices from the coordinate field.

Access type: inputOutput
Value range: >=2

LineSet_coord.dot

Referenced by LineSet(), and render().


The documentation for this class was generated from the following files:

Generated on Fri Nov 7 10:30:32 2008 for H3D API by  doxygen 1.5.7