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:

Classes
class	DisplayList
	Display list is extended in order to set color to emissive color from material outside of display list, since we have to do a glGet to get the value. More...

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

class	MFVertexAttributeNode
	The MFVertexAttributeNode is dependent on the propertyChanged field of the contained X3DVertexAttributeNode. 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 Types inherited from H3D::Node
typedef std::map< Node , Node >	DeepCopyMap
	A map type used during a deep copy clone() to map from original nodes to cloned nodes.

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, Inst< MFVertexAttributeNode > _attrib=0)
	Constructor.

virtual int	nrLines ()
	The number of lines rendered by this geometry.

virtual void	render ()
	Render the LineSet with OpenGL.

virtual void	traverseSG (TraverseInfo &ti)
	Traverse the scenegraph. More...

Public Member Functions inherited from H3D::X3DGeometryNode
	X3DGeometryNode (Inst< SFNode > _metadata=0, Inst< SFBound > _bound=0, Inst< DisplayList > _displayList=0, Inst< MFBool > _isTouched=0, Inst< MFVec3f > _force=0, Inst< MFVec3f > _contactPoint=0, Inst< MFVec3f > _contactNormal=0, Inst< MFVec3f > _contactTexCoord=0, Inst< SFBoundTree > _boundTree=0, Inst< SFVec3f > _centerOfMass=0)
	Constructor.

virtual bool	lineIntersect (const Vec3f &from, const Vec3f &to, LineIntersectResult &result)
	Detect intersection between a line segment and this geometry. More...

virtual void	closestPoint (const Vec3f &p, NodeIntersectResult &result)
	Find closest point on this geometry to point p. More...

virtual bool	movingSphereIntersect (H3DFloat radius, const Vec3f &from, const Vec3f &to, NodeIntersectResult &result)
	Detect collision between a moving sphere and the geometry. More...

virtual void	glRender ()
	Function overridden from HAPIGLShape. More...

virtual H3DShadowObjectNode *	getShadowObject ()
	Get the H3DShadowObjectNode used to create a shadow volume for this geometry. More...

void	useCulling (bool enabled)
	This function should be used by the render() function to disable or enable face culling. More...

bool	usingCulling ()
	Returns if face culling is in use or not.

void	allowCulling (bool allow)
	Control if face culling is allowed or not. More...

void	useBackFaceCulling (bool enabled)
	Enabling/disabling back face culling. More...

bool	allowingCulling ()
	Returns true if back face culling is allowed, false otherwise.

void	setCullFace (GLenum face)
	Set which side of a polygon to cull. More...

GLenum	getCullFace ()
	Get which face will be culled if culling is enabled.

template<class OptionNodeType >
void	getOptionNode (OptionNodeType *&option)
	Get the first option node of the type of the pointer given as argument from the renderOptions fieeld The option argument will contain the node afterwards, or NULL if no option of that type exists.

int	getHapticShapeId (unsigned int index)
	Get a shape id to be used for rendering of this geometry with HLAPI for the given haptics device. More...

virtual	~X3DGeometryNode ()
	Destructor.

HAPI::HAPIHapticShape *	getOpenGLHapticShape (unsigned int hd_index, H3DSurfaceNode *_surface, const Matrix4f &_transform, int _nr_vertices=-1)
	Returns a either a HLFeedbackShape or a HLDepthBufferShape with the X3DGeometryNode. More...

virtual string	defaultXMLContainerField ()
	Returns the default xml containerField attribute value. More...

virtual bool	supportsTangentAttributes ()
	Returns true if this geometry supports the automatic generation of tangents and binormals as FloatVertexAttribues(needed by e.g. More...

virtual void	getBound (HAPI::Vec3 &center, HAPI::Vec3 &size)
	Overriden from HAPIGLShape to use the bound field in he X3DGeometryNode. More...

virtual void	initialize ()
	Changes behaviour of X3DGeometryNode to be a thread safe RefCountedClass.

Public Member Functions inherited from H3D::X3DChildNode
	X3DChildNode (Inst< SFNode > _metadata=0)
	Constructor.

Public Member Functions inherited from H3D::X3DNode
	X3DNode (Inst< SFNode > _metadata=0)
	Constructor.

X3DMetadataObject *	getMetadataByName (const string &_name)
	Given a name, the first X3DMetadataObject in the metadata field that matches that name is returned. More...

Public Member Functions inherited from H3D::Node
	Node ()
	Constructor.

virtual Node *	clone (bool deepCopy=true, DeepCopyMap *deepCopyMap=NULL)
	Returns a new instance of this node type with the same state as this one. More...

virtual	~Node ()
	Destructor.

X3DPrototypeInstance *	getProtoInstanceParent ()
	If this node is the root node in the proto body of a X3DPrototypeInstance then this will return that node. More...

void	setProtoInstanceParent (X3DPrototypeInstance *p)
	Set the X3DPrototypeInstance this node is the the root node if applicaple.

virtual Field *	getField (const string &_name) const
	return a pointer to the field specified by name within this instance

int	addDestructCallback (void(func)(Node , void ), void args)
	Add a callback function to be run on destruction of node. More...

int	removeDestructCallback (void(func)(Node , void ), void args)
	Add a callback function to be run on destruction of node. More...

Public Member Functions inherited from H3D::H3DBoundedObject
	H3DBoundedObject (Inst< SFBound > _bound=0)
	Constructor.

Public Member Functions inherited from H3D::H3DDisplayListObject
	H3DDisplayListObject (Inst< DisplayList > _displayList=0)
	Constructor.

Public Attributes
H3DUniquePtr< SFColorNode >	color
	The color field specifies the colour of the line set at each vertex and contains a X3DColorNode. More...

H3DUniquePtr< SFCoordinateNode >	coord
	The coord field specifies the 3D vertices of the line set and contains a X3DCoordinateNode. More...

H3DUniquePtr< MFInt32 >	vertexCount
	The vertexCount field describes how many vertices are to be used in each polyline from the coordinate field. More...

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

H3DUniquePtr< MFVertexAttributeNode >	attrib
	If the attrib field is not empty it shall contain a list of X3DVertexAttributeNode instances with per-vertex attribute information for programmable shaders. More...

Public Attributes inherited from H3D::X3DGeometryNode
H3DUniquePtr< MFBool >	isTouched
	Tells if a HapticsDevice has been in contact with the geometry in the last scenegraph loop. More...

H3DUniquePtr< MFVec3f >	force
	The last force delivered by this geometry to the haptics device. More...

H3DUniquePtr< MFVec3f >	contactPoint
	The last contact points of the HapticDevices on the geometry. More...

H3DUniquePtr< MFVec3f >	contactTexCoord
	The texture coordinate of last the contact points of the HapticDevices on the geometry. More...

H3DUniquePtr< MFVec3f >	contactNormal
	The normal at the last contact points of the HapticDevices on the geometry. More...

H3DUniquePtr< SFVec3f >	centerOfMass
	The field contains center of mass for the object, based on its bounding box. More...

H3DUniquePtr< SFBoundTree >	boundTree
	Contains a tree of the HAPI::GeometryPrimitives that build up the X3DGeometryNode. More...

H3DUniquePtr< MFOptionsNode >	options
	Contains nodes with options for haptics and graphics rendering. More...

Public Attributes inherited from H3D::X3DNode
H3DUniquePtr< SFNode >	metadata
	Meta data about the node. More...

Public Attributes inherited from H3D::H3DBoundedObject
H3DUniquePtr< SFBound >	bound
	The field containing the bound object. More...

Public Attributes inherited from H3D::H3DDisplayListObject
H3DUniquePtr< DisplayList >	displayList
	The DisplayList instance handling the OpenGL caching of this object.

Static Public Attributes
static H3DNodeDatabase	database
	The H3DNodeDatabase for this node.

Static Public Attributes inherited from H3D::X3DGeometryNode
static H3DNodeDatabase	database
	The H3DNodeDatabase for this node.

Static Public Attributes inherited from H3D::X3DNode
static H3DNodeDatabase	database
	The H3DNodeDatabase for this node.

Protected Attributes
bool	render_patches
	This will be set to true in traverseSG if the render function is supposed to render GL_PATCHES instead of GL_LINES. More...

Protected Attributes inherited from H3D::X3DGeometryNode
AutoRef< Node >	shadow_volume
	The shadow volume used for this geometry when shadows enabled. More...

vector< pair< int, pair< Matrix4f, H3DTime > > >	haptic_shape_ids
	identifiers for the shapes geometry.

Additional Inherited Members
Static Public Member Functions inherited from H3D::Node
static unsigned int	nrNodesAlive ()
	Returns the nr of nodes currently alive, i.e. nodes created but not destructed.

static int	nrNodesCreated ()
	Returns the number of nodes created in total since the start of the program.

Protected Member Functions inherited from H3D::Node
void	cloneFieldValue (Field &_from, Field &_to, bool deepCopy, DeepCopyMap &deepCopyMap)
	A helper function for the clone() method. More...

Static Protected Member Functions inherited from H3D::X3DGeometryNode
static void	cleanUpFunction (void *userdata)
	Function sent to HAPIHapticsShape created to allow for deletion of X3DGeometryNode at the correct time. More...

Static Protected Member Functions inherited from H3D::Node
static Node *	getClonedInstance (Node *original, bool deepCopy, DeepCopyMap &deepCopyMap)
	A helper function for nodes that implement clone() More...

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

Examples:

LineSet.x3d ( Source )

Internal routes:

Member Function Documentation

◆ traverseSG()

void LineSet::traverseSG ( TraverseInfo & ti )

virtual

Traverse the scenegraph.

A HAPIHapticShape is added for haptic rendering if haptics is enabled.

Parameters

ti	The TraverseInfo object containing information about the traversal.

Reimplemented from H3D::X3DGeometryNode.

References H3D::H3DDisplayListObject::displayList, H3DUtil::RefCountedClass::getName(), H3D::TraverseInfo::getUserData(), render_patches, and H3D::X3DGeometryNode::traverseSG().

Member Data Documentation

◆ attrib

H3DUniquePtr< MFVertexAttributeNode > H3D::LineSet::attrib

If the attrib field is not empty it shall contain a list of X3DVertexAttributeNode instances with per-vertex attribute information for programmable shaders.

Access type: inputOutput

Referenced by LineSet(), and render().

◆ color

H3DUniquePtr< SFColorNode > H3D::LineSet::color

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

Referenced by H3D::LineSet::DisplayList::callList(), LineSet(), and render().

◆ coord

H3DUniquePtr< SFCoordinateNode > H3D::LineSet::coord

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

Access type: inputOutput

Referenced by LineSet(), and render().

◆ fogCoord

H3DUniquePtr< SFFogCoordinate > H3D::LineSet::fogCoord

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

Access type: inputOutput

Referenced by LineSet(), and render().

◆ render_patches

bool H3D::LineSet::render_patches

protected

This will be set to true in traverseSG if the render function is supposed to render GL_PATCHES instead of GL_LINES.

If multiple uses of the LineSet then whether patches are rendered or not is decided by the last usage to be traversed.

Referenced by render(), and traverseSG().

◆ vertexCount

H3DUniquePtr< MFInt32 > H3D::LineSet::vertexCount

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

Referenced by LineSet(), and render().

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

Classes

Public Types

Public Member Functions

Public Attributes

Static Public Attributes

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ traverseSG()

Member Data Documentation

◆ attrib

◆ color

◆ coord

◆ fogCoord

◆ render_patches

◆ vertexCount