Home Hierarchy Members Alphabetical Related Pages

Color Class Reference
[Standard Node Types]

#include <color.h>

Inherits Node.

List of all members.

Public Member Functions

 Color (const char *name="")
virtual ~Color ()
virtual unsigned int nbFields () const
virtual FieldHandle field (const std::string &n)
virtual FieldHandle field (unsigned int i)
virtual bool isSetToDefaultValue (unsigned int i) const
virtual unsigned int nbEventsIn () const
virtual EventInHandle eventIn (const std::string &n)
virtual EventInHandle eventIn (unsigned int i)
virtual unsigned int nbEventsOut () const
virtual EventOutHandle eventOut (const std::string &n)
virtual EventOutHandle eventOut (unsigned int i)
const char * typeName () const
virtual Nodeduplicate () const
virtual Nodeduplicate (std::map< const Node *, Node * > &) const

Public Attributes

Exposed Fields
A field that is capable of receiving events via an eventIn to change its value(s), and generating events via an eventOut when its value(s) change.

MFColor color
Events In
EventIn< MFColorset_color
Events Out
EventOut< MFColorcolor_changed


Detailed Description

Here is the documentation for this node type, from the ISO standard.

+6.9 Color

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. Details on lighting equations can be found in 4.14, Lighting model.

--- VRML separator bar ---


Constructor & Destructor Documentation

Color ( const char *  name = ""  ) 

Construct a node with all its fields set to default value, which is equivalent to the code below:

~Color (  )  [virtual]

Virtual destructor, does nothing


Member Function Documentation

unsigned int nbFields (  )  const [inline, virtual]

Returns the number of fields (exposed or not) for this node type.

Implements Node.

wrl::Node::FieldHandle field ( const std::string &  n  )  [virtual]

Return a handle on the field named n of the node or a "unknown" typed handle if there is no such field. Valid names are:

Implements Node.

wrl::Node::FieldHandle field ( unsigned int  n  )  [virtual]

Return a handle on the i th field of the node or a "unknown" typed handle if there is no such node. Here is how i is related to fields:

Implements Node.

bool isSetToDefaultValue ( unsigned int  i  )  const [virtual]

Implements Node.

unsigned int nbEventsIn (  )  const [inline, virtual]

Returns the number of events in for this node type.

Implements Node.

wrl::Node::EventInHandle eventIn ( const std::string &  n  )  [virtual]

Return a handle on the event in named n of the node or a "unknown" typed handle if there is no such event. Valid names are:

Implements Node.

wrl::Node::EventInHandle eventIn ( unsigned int  n  )  [virtual]

Return a handle on the i th event in of the node or a "unknown" typed handle if there is no such node. emarks This class has no eventIn. This function is useful, with nbEventsIn() if you want to traverse all events in of a Node.

Implements Node.

unsigned int nbEventsOut (  )  const [inline, virtual]

Returns the number of events out for this node type.

Implements Node.

wrl::Node::EventOutHandle eventOut ( const std::string &  n  )  [virtual]

Return a handle on the event out named n of the node or a "unknown" typed handle if there is no such event. Valid names are:

Implements Node.

wrl::Node::EventOutHandle eventOut ( unsigned int  n  )  [virtual]

Return a handle on the i th event out of the node or a "unknown" typed handle if there is no such node. Here is how i is related to fields:

Implements Node.

const char * typeName (  )  const [inline, virtual]

Returns "Color". Useful for printing.

Implements Node.

wrl::Node * duplicate (  )  const [virtual]

Returns a deep copy of this node, that is a fully independant node with all children (if any) also copied. This is mainly useful for instanciating protos.

Implements Node.

virtual Node* duplicate ( std::map< const Node *, Node * > &   )  const [virtual]

Implements Node.


Member Data Documentation

MFColor color

See Detailed Description for meaning of this field. Default value is set to MFColor default value

EventIn<MFColor> set_color

Set event associated to exposedField color

EventOut<MFColor> color_changed

Changed event associated to exposedField color


Generated on 5 Jan 2007 with doxygen version 1.5.1. Valid HTML 4.0! Valid CSS!