Home Hierarchy Members Alphabetical Related Pages

OrientationInterpolator Class Reference
[Standard Node Types]

#include <orientationinterpolator.h>

Inherits Node.

List of all members.

Public Member Functions

 OrientationInterpolator (const char *name="")
virtual ~OrientationInterpolator ()
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.

MFFloat key
MFRotation keyValue
Events In
EventIn< SFFloatset_fraction
EventIn< MFFloatset_key
EventIn< MFRotationset_keyValue
Events Out
EventOut< SFRotationvalue_changed
EventOut< MFFloatkey_changed
EventOut< MFRotationkeyValue_changed


Detailed Description

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

+6.50 OrientationInterpolator

The OrientationInterpolator node interpolates among a list of rotation values specified in the keyValue field. These rotations are absolute in object space and therefore are not cumulative. The keyValue field shall contain exactly as many rotations as there are keyframes in the key field.

An orientation represents the final position of an object after a rotation has been applied. An OrientationInterpolator interpolates between two orientations by computing the shortest path on the unit sphere between the two orientations. The interpolation is linear in arc length along this path. The results are undefined if the two orientations are diagonally opposite.

If two consecutive keyValue values exist such that the arc length between them is greater than , the interpolation will take place on the arc complement. For example, the interpolation between the orientations (0, 1, 0, 0) and (0, 1, 0, 5.0) is equivalent to the rotation between the orientations (0, 1, 0, 2) and (0, 1, 0, 5.0).

A more detailed discussion of interpolators is contained in 4.6.8, Interpolator nodes.

--- VRML separator bar ---


Constructor & Destructor Documentation

OrientationInterpolator ( const char *  name = ""  ) 

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

~OrientationInterpolator (  )  [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. Here is how i is related to fields:

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

MFFloat key

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

MFRotation keyValue

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

EventIn<SFFloat> set_fraction

See Detailed Description for meaning of this event.

EventIn<MFFloat> set_key

Set event associated to exposedField key

EventIn<MFRotation> set_keyValue

Set event associated to exposedField keyValue

EventOut<SFRotation> value_changed

See Detailed Description for meaning of this event.

EventOut<MFFloat> key_changed

Changed event associated to exposedField key

EventOut<MFRotation> keyValue_changed

Changed event associated to exposedField keyValue


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