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

The LineProperties node specifies additional properties to be applied to all line geometry. More...

#include <H3D/LineProperties.h>

Inheritance diagram for H3D::LineProperties:

Inheritance graph

List of all members.

Public Member Functions

 LineProperties (Inst< DisplayList > _displayList=0, Inst< SFNode > _metadata=0, Inst< SFBool > _applied=0, Inst< SFInt32 > _linetype=0, Inst< SFFloat > _linewidthScaleFactor=0)
 Constructor.
virtual void preRender ()
 This function will be called by the X3DShapeNode before any rendering of geometry and before the call to the render function.
virtual void postRender ()
 This function will be called by the X3DShapeNode after the geometry has been rendered to restore the states to what it was before the call to preRender().
virtual void render ()
 Set up the line properties with OpenGL.
virtual string defaultXMLContainerField ()
 Returns the default xml containerField attribute value.

Public Attributes

auto_ptr< SFBoolapplied
 Determines if the linetype and linewidthScaleFactor should be applied or not.
auto_ptr< SFInt32linetype
 The linetype field selects a line pattern to be used for lines.
auto_ptr< SFFloatlinewidthScaleFactor
 The linewidthScaleFactor is a multiplicative value that scales the nominal linewidth by the linewidth scale factor.

Static Public Attributes

static H3DNodeDatabase database
 The H3DNodeDatabase for this node.


Detailed Description

The LineProperties node specifies additional properties to be applied to all line geometry.

The linetype and linewidth shall only be applied when the applied field has value TRUE. When the value of the applied field is FALSE, a solid line of nominal width shall be produced. The colour of the line is specified by the associated Material node.

The linetype field selects a line pattern as defined in the International Register of Graphical Items. The following line patterns are available:

  1. Solid
  2. Dashed
  3. Dotted
  4. Dashed-dotted
  5. Dash-dot-dot

The linewidthScaleFactor is a multiplicative value that scales the nominal linewidth by the linewidth scale factor. This resulting value shall then be mapped to the nearest available line width. A value less than or equal to zero refers to the minimum available line width.

Changing the line types does NOT CHANGE THE HAPTIC RENDERING of lines. It only changes the visual appearance.

Internal routes:
LineProperties.dot

Member Function Documentation

virtual string H3D::LineProperties::defaultXMLContainerField (  )  [inline, virtual]

Returns the default xml containerField attribute value.

For this node it is "lineProperties".

Reimplemented from H3D::Node.

virtual void H3D::LineProperties::postRender (  )  [inline, virtual]

This function will be called by the X3DShapeNode after the geometry has been rendered to restore the states to what it was before the call to preRender().

Reimplemented from H3D::X3DAppearanceChildNode.

Referenced by H3D::Appearance::postRender().

virtual void H3D::LineProperties::preRender (  )  [inline, virtual]

This function will be called by the X3DShapeNode before any rendering of geometry and before the call to the render function.

So this is the place to save the states that are going to be changed in render() in order to restore it in postRender().

Reimplemented from H3D::X3DAppearanceChildNode.

Referenced by H3D::Appearance::preRender().


Member Data Documentation

Determines if the linetype and linewidthScaleFactor should be applied or not.

Access type: inputOutput
Default value: true

LineProperties_applied.dot

Referenced by LineProperties(), and render().

The linetype field selects a line pattern to be used for lines.

For more information see the Detailed description

Access type: inputOutput
Default value: 1

LineProperties_linetype.dot

Referenced by LineProperties(), and render().

The linewidthScaleFactor is a multiplicative value that scales the nominal linewidth by the linewidth scale factor.

This resulting value shall then be mapped to the nearest available line width. A value less than or equal to zero refers to the minimum available line width.

Access type: inputOutput
Default value: 0

LineProperties_linewidthScaleFactor.dot

Referenced by LineProperties(), 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