Box Class Reference
[Standard Node Types]

#include <box.h>

Inherits Node.

Inheritance diagram for Box:

[legend]List of all members.

Public Member Functions
	Box (const char *name="")
virtual	~Box ()
virtual unsigned int	nbFields () const
virtual FieldHandle	field (const std::string &n)
virtual FieldHandle	field (const unsigned int i)
virtual bool	isSetToDefaultValue (const unsigned int i) const
virtual unsigned int	nbEventsIn () const
virtual EventInHandle	eventIn (const std::string &n)
virtual EventInHandle	eventIn (const unsigned int i)
virtual unsigned int	nbEventsOut () const
virtual EventOutHandle	eventOut (const std::string &n)
virtual EventOutHandle	eventOut (const unsigned int i)
const char *	typeName () const
virtual Node *	duplicate () const
virtual Node *	duplicate (std::map< const Node *, Node * > &) const
Public Attributes
Fields
A property or attribute of a node. Each node type has a fixed set of fields. Fields may contain various kinds of data and one or many values. Each field has a default value.
SFVec3f	size

---

Detailed Description

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

6.7 Box

The Box node specifies a rectangular parallelepiped box centred at (0, 0, 0) in the local coordinate system and aligned with the local coordinate axes. By default, the box measures 2 units in each dimension, from -1 to +1. The size field specifies the extents of the box along the X-, Y-, and Z-axes respectively and each component value shall be greater than zero. Figure 6.2 illustrates the Box node.

Figure 6.2 -- Box node

Textures are applied individually to each face of the box. On the front (+Z), back (-Z), right (+X), and left (-X) faces of the box, when viewed from the outside with the +Y-axis up, the texture is mapped onto each face with the same orientation as if the image were displayed normally in 2D. On the top face of the box (+Y), when viewed from above and looking down the Y-axis toward the origin with the -Z-axis as the view up direction, the texture is mapped onto the face with the same orientation as if the image were displayed normally in 2D. On the bottom face of the box (-Y), when viewed from below looking up the Y-axis toward the origin with the +Z-axis as the view up direction, the texture is mapped onto the face with the same orientation as if the image were displayed normally in 2D. TextureTransform affects the texture coordinates of the Box.

The Box node's geometry requires outside faces only. When viewed from the inside the results are undefined.

---

Constructor & Destructor Documentation

Box (  const char *  name = ""  )

Construct a node with all its fields set to default value, which is equivalent to the code below: size.setXYZ(2,2,2);

~Box (   )  [virtual]

Virtual destructor, does nothing

---

Member Function Documentation

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

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.

wrl::Node::EventInHandle eventIn (  const unsigned int  i  )  [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.

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::EventOutHandle eventOut (  const unsigned int  i  )  [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: This function is useful, with nbEventsOut() if you want to traverse all events in of a Node. 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::FieldHandle field (  const 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: 0 : size This function is useful, with nbFields() if you want to traverse all fields of a Node. 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: size Implements Node.

bool isSetToDefaultValue (  const 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.

unsigned int nbEventsOut (   )  const [inline, virtual]

Returns the number of events out for this node type. Implements Node.

unsigned int nbFields (   )  const [inline, virtual]

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

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

Returns "Box". Useful for printing. Implements Node.

---

Member Data Documentation

SFVec3f size

See Detailed Description for meaning of this field. Default value is set to size.setXYZ(2,2,2);

---

Generated on 24 Feb 2005 with version 1.3.9.1.