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

This node defines a set of RGB colours to be used in the fields of another node. More...

#include <H3D/Color.h>

Inheritance diagram for H3D::Color:
Inheritance graph

Public Member Functions

 Color (Inst< MFColor > _color=0, Inst< SFNode > _metadata=0)
 Constructor.
 
virtual ~Color ()
 Destructor.
 
virtual RGBA getColor (unsigned int i)
 Get the color at index i.
 
virtual void render (int index)
 Perform the OpenGL commands to render a color given the index of the color. More...
 
virtual void renderArray ()
 Perform the OpenGL commands to render all vertices as a vertex array.
 
virtual void disableArray ()
 Disable the array state enabled in renderArray().
 
virtual unsigned int nrAvailableColors ()
 Returns the number of color this color node can render.
 
virtual void setAttributeData ()
 Implement the method to specify data and releated information.
 
virtual void renderVBO ()
 VBO rendering implementation.
 
virtual void disableVBO ()
 VBO disabling implementation.
 
virtual bool preRenderCheckFail ()
 Check if this vertex attribute needs to be rendered.
 
- Public Member Functions inherited from H3D::X3DColorNode
 X3DColorNode (Inst< SFNode > _metadata=0)
 Constructor.
 
virtual void preRender ()
 Enable state needed before rendering the color.
 
virtual void postRender ()
 Disable state set in preRender() function.
 
virtual string defaultXMLContainerField ()
 Returns the default xml containerField attribute value. More...
 
- Public Member Functions inherited from H3D::X3DGeometricPropertyNode
 X3DGeometricPropertyNode (Inst< SFNode > _metadata=0)
 Constructor.
 
- 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 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::GLVertexAttributeObject
 GLVertexAttributeObject (VERTEXATTRIBUTE::VERTEXATTRIBUTETYPE type)
 Constructor.
 
virtual ~GLVertexAttributeObject ()
 Destructor.
 
void renderVertexBufferObject ()
 Perform the OpenGL commands to render all vertices as a vertex buffer object.
 
void disableVertexBufferObject ()
 Disable the vertex buffer object enabled in renderVertexBufferObject().
 
virtual void updateVertexBufferObject ()
 Perform the OpenGL commands to update vertex attribute data/format.
 

Public Attributes

H3DUniquePtr< MFColorcolor
 A vector of Color values. More...
 
- Public Attributes inherited from H3D::X3DGeometricPropertyNode
H3DUniquePtr< FieldpropertyChanged
 Field that indicated whether the properties have changed. More...
 
- Public Attributes inherited from H3D::X3DNode
H3DUniquePtr< SFNodemetadata
 Meta data about the node. More...
 
- Public Attributes inherited from H3D::GLVertexAttributeObject
H3DUniquePtr< SFBoolisDynamic
 Option to indicate whether this vertex attribute is dynamic or not Access type: inputOutput
Default value: false.
 

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...
 
- Protected Attributes inherited from H3D::GLVertexAttributeObject
H3DUniquePtr< FieldvboFieldsUpToDate
 Internal field used to know if vertex buffer object can be created. More...
 

Detailed Description

This node defines a set of RGB colours to be used in the fields of another node.

Color nodes are only used to specify multiple colours for a single geometric shape, such as colours for the faces or vertices of an IndexedFaceSet. A Material node is used to specify the overall material parameters of lit geometry. If both a Material node and a Color node are specified for a geometric shape, the colours shall replace the diffuse component of the material.

RGB or RGBA textures take precedence over colours; specifying both an RGB or RGBA texture and a Color node for geometric shape will result in the Color node being ignored.

Examples:

Internal routes:

Member Function Documentation

◆ render()

virtual void H3D::Color::render ( int  index)
inlinevirtual

Perform the OpenGL commands to render a color given the index of the color.

Installs the normal as a glColor3f.

Reimplemented from H3D::X3DColorNode.

Member Data Documentation

◆ color

H3DUniquePtr< MFColor > H3D::Color::color

A vector of Color values.

Access type: inputOutput

Referenced by Color(), preRenderCheckFail(), renderArray(), and setAttributeData().


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