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

This is the base node type for all Appearance nodes. More...

#include <H3D/X3DAppearanceNode.h>

Inheritance diagram for H3D::X3DAppearanceNode:
Inheritance graph

Public Member Functions

 X3DAppearanceNode (Inst< DisplayList > _displayList=0, Inst< SFNode > _metadata=0, Inst< SFSurface > _surface=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.
 
virtual GLbitfield getAffectedGLAttribs ()
 Returns a bitmask of the OpenGL attrib bits that will be affected by this node. More...
 
virtual bool isTransparent ()
 This function checks the transparency field to determine if the material requires that the geometry is rendered with transparency.
 
virtual bool hasGeometryShadow ()
 This function return true if the appearance has decided that shadow should be cast. More...
 
virtual bool usingMultiPassTransparency ()
 This function checks if multi-pass transparency should be used or not (see RenderProperties_multiPassTransparency)
 
virtual string defaultXMLContainerField ()
 Returns the default xml containerField attribute value. More...
 
virtual void traverseSG (TraverseInfo &ti)
 Traversing the scene graph. More...
 
- 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 render ()
 the render() function is used for the depth-first rendering traversal of the scene-graph. 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.
 

Static Public Member Functions

static void setDefaultUsingMultiPassTransparency (bool b)
 Set the default value for usage of multi pass transparancy. More...
 
static bool getDefaultUsingMultiPassTransparency ()
 Get the default value for usage of multi pass transparancy.
 
- 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.
 

Public Attributes

H3DUniquePtr< SFSurfacesurface
 Contains the Surface node that will determine how an object will feel haptically. 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.
 

Static Protected Attributes

static bool default_using_multi_pass_transparency = true
 The default value to use for multipass transparency, if the inherited appearance node does not contain any information about using multipass transparency.
 

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

This is the base node type for all Appearance nodes.

Member Function Documentation

◆ defaultXMLContainerField()

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

Returns the default xml containerField attribute value.

For this node it is "appearance".

Reimplemented from H3D::Node.

◆ getAffectedGLAttribs()

virtual GLbitfield H3D::X3DAppearanceNode::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 in H3D::Appearance.

Referenced by H3D::Appearance::getAffectedGLAttribs(), H3D::ParticleSystem::render(), and H3D::X3DShapeNode::render().

◆ hasGeometryShadow()

virtual bool H3D::X3DAppearanceNode::hasGeometryShadow ( )
inlinevirtual

This function return true if the appearance has decided that shadow should be cast.


Reimplemented in H3D::Appearance.

Referenced by H3D::X3DShapeNode::traverseSG().

◆ preRender()

virtual void H3D::X3DAppearanceNode::preRender ( )
inlinevirtual

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


Reimplemented in H3D::Appearance.

Referenced by H3D::Appearance::preRender(), H3D::ParticleSystem::render(), and H3D::X3DShapeNode::render().

◆ setDefaultUsingMultiPassTransparency()

static void H3D::X3DAppearanceNode::setDefaultUsingMultiPassTransparency ( bool  b)
inlinestatic

Set the default value for usage of multi pass transparancy.

This is the value that will be used if the inherited appearance node does not contain any information about using multipass transparency

Referenced by H3D::Scene::idle().

◆ traverseSG()

void X3DAppearanceNode::traverseSG ( TraverseInfo ti)
virtual

Traversing the scene graph.

The current surface will be set to the surface of the X3DAppearanceNode.

Parameters
tiThe TraverseInfo object containing information about the traversal.

Reimplemented from H3D::Node.

Reimplemented in H3D::Appearance.

References H3D::TraverseInfo::setCurrentSurface(), and surface.

Referenced by H3D::Appearance::traverseSG(), and H3D::X3DShapeNode::traverseSG().

Member Data Documentation

◆ surface

H3DUniquePtr< SFSurface > H3D::X3DAppearanceNode::surface

Contains the Surface node that will determine how an object will feel haptically.

Access type: inputOutput

Referenced by H3D::Appearance::traverseSG(), and traverseSG().


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