H3D API  2.4.1
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
H3D::FillProperties Class Reference

The FillProperties node specifies additional properties to be applied to all polygonal areas on top of whatever appearance is specified by the other fields of the respective Appearance node. More...

#include <H3D/FillProperties.h>

Inheritance diagram for H3D::FillProperties:
Inheritance graph

Public Member Functions

 FillProperties (Inst< DisplayList > _displayList=0, Inst< SFBool > _filled=0, Inst< SFColor > _hatchColor=0, Inst< SFBool > _hatched=0, Inst< SFInt32 > _hatchStyle=0, Inst< SFNode > _metadata=0)
 Constructor.
 
virtual GLbitfield getAffectedGLAttribs ()
 Returns a bitmask of the OpenGL attrib bits that will be affected by this node. More...
 
virtual void render ()
 Set up the line properties with OpenGL.
 
virtual string defaultXMLContainerField ()
 Returns the default xml containerField attribute value. More...
 
- Public Member Functions inherited from H3D::X3DAppearanceChildNode
 X3DAppearanceChildNode (Inst< DisplayList > _displayList=0, Inst< SFNode > _metadata=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. More...
 
virtual void postRender ()
 This function will be called by the X3DShapeNode after the geometry has been rendered.
 
- Public Member Functions inherited from H3D::X3DNode
 X3DNode (Inst< SFNode > _metadata=0)
 Constructor.
 
X3DMetadataObjectgetMetadataByName (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 Nodeclone (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.
 
X3DPrototypeInstancegetProtoInstanceParent ()
 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 void traverseSG (TraverseInfo &ti)
 traverseSG is called once per scenegraph loop on the scene in order to traverse the scenegraph. More...
 
virtual bool lineIntersect (const Vec3f &from, const Vec3f &to, LineIntersectResult &result)
 Detect intersection between a line segment and the Node. More...
 
virtual void closestPoint (const Vec3f &p, NodeIntersectResult &result)
 Find closest point on Node to p. More...
 
virtual bool movingSphereIntersect (H3DFloat radius, const Vec3f &from, const Vec3f &to, NodeIntersectResult &result)
 Detect collision between a moving sphere and the Node. More...
 
virtual FieldgetField (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::H3DDisplayListObject
 H3DDisplayListObject (Inst< DisplayList > _displayList=0)
 Constructor.
 

Public Attributes

H3DUniquePtr< SFBoolfilled
 The filled field specifies if the geometry should be filled or not. More...
 
H3DUniquePtr< SFColorhatchColor
 The color of the hatches. More...
 
H3DUniquePtr< SFBoolhatched
 The hatched field specifies if the geometry should be hatched or not. More...
 
H3DUniquePtr< SFInt32hatchStyle
 The hatchStyle field selects a hatch pattern to be used. More...
 
- Public Attributes inherited from H3D::X3DNode
H3DUniquePtr< SFNodemetadata
 Meta data about the node. More...
 
- Public Attributes inherited from H3D::H3DDisplayListObject
H3DUniquePtr< DisplayListdisplayList
 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::X3DNode
static H3DNodeDatabase database
 The H3DNodeDatabase for this node.
 

Additional Inherited Members

- 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.
 
- 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::Node
static NodegetClonedInstance (Node *original, bool deepCopy, DeepCopyMap &deepCopyMap)
 A helper function for nodes that implement clone() More...
 

Detailed Description

The FillProperties node specifies additional properties to be applied to all polygonal areas on top of whatever appearance is specified by the other fields of the respective Appearance node.

The filled field specifies if the geometry should be filled or not. If not filled it will be rendered as wireframe.

Hatches are applied on top of the already rendered appearance of the node. Hatches are not affected by lighting.

The hatchStyle field selects a hatch pattern as defined in the International Register of Graphical Items. The hatches are rendered using the colour specified by the hatchColor field. The following hatch styles are available:

  1. horizontal, equally spaced lines
  2. vertical, equally spaced lines
  3. positive slope, equally spaced lines
  4. negative slope, equally spaced lines
  5. horizontal/vertical crosshatch
  6. positive slope/negative slope crosshatch

The associated geometry shall be filled and/or hatched only when the respective values of the filled and/or hatched fields have value TRUE.

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

Examples:

Internal routes:

Member Function Documentation

◆ defaultXMLContainerField()

virtual string H3D::FillProperties::defaultXMLContainerField ( )
inlinevirtual

Returns the default xml containerField attribute value.

For this node it is "fillProperties".

Reimplemented from H3D::Node.

◆ getAffectedGLAttribs()

virtual GLbitfield H3D::FillProperties::getAffectedGLAttribs ( )
inlinevirtual

Returns a bitmask of the OpenGL attrib bits that will be affected by this node.

The value can be used in glPushAttrib in order to save the current state.

Reimplemented from H3D::X3DAppearanceChildNode.

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

Member Data Documentation

◆ filled

H3DUniquePtr< SFBool > H3D::FillProperties::filled

The filled field specifies if the geometry should be filled or not.

If not filled it will be rendered as wireframe.

Access type: inputOutput
Default value: true

Referenced by FillProperties(), and render().

◆ hatchColor

H3DUniquePtr< SFColor > H3D::FillProperties::hatchColor

The color of the hatches.

Access type: inputOutput
Default value: RGB( 1,1,1 )

Referenced by FillProperties(), and render().

◆ hatched

H3DUniquePtr< SFBool > H3D::FillProperties::hatched

The hatched field specifies if the geometry should be hatched or not.

Access type: inputOutput
Default value: true

Referenced by FillProperties(), and render().

◆ hatchStyle

H3DUniquePtr< SFInt32 > H3D::FillProperties::hatchStyle

The hatchStyle field selects a hatch pattern to be used.

For more information see the Detailed description

Access type: inputOutput
Default value: 1

Referenced by FillProperties(), and render().


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