XdkWrl: NurbsPositionInterpolator Class Reference

Home | Hierarchy | Members | Alphabetical | Related Pages

# NurbsPositionInterpolator Class Reference
[Standard Node Types]

`#include <nurbspositioninterpolator.h>`

Inherits Node.

List of all members.

## Public Member Functions
| NurbsPositionInterpolator (const char *name="")
virtual | ~NurbsPositionInterpolator ()
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 Node * | duplicate () const
virtual Node * | duplicate (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.
SFInt32 | dimension
MFVec3f | keyValue
MFFloat | keyWeight
MFFloat | knot
SFInt32 | order
Events In
EventIn< SFFloat > | set_fraction
EventIn< SFInt32 > | set_dimension
EventIn< MFVec3f > | set_keyValue
EventIn< MFFloat > | set_keyWeight
EventIn< MFFloat > | set_knot
EventIn< SFInt32 > | set_order
Events Out
EventOut< SFVec3f > | value_changed
EventOut< SFInt32 > | dimension_changed
EventOut< MFVec3f > | keyValue_changed
EventOut< MFFloat > | keyWeight_changed
EventOut< MFFloat > | knot_changed
EventOut< SFInt32 > | order_changed

## Detailed Description

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

## 6.47 NurbsPositionInterpolator

NurbsPositionInterpolator describes a 3D NURBS Curve using dimension, keyValue, keyWeight, knot, and order as described for the NurbsCurve node.

The fields set_fraction and value_changed have the same meaning as in the base VRML PositionInterpolator.

Sending a set_fraction input computes a 3D position on the curve, which is sent by value_changed. The set_fraction value is used as the input value for the tessellation function. Thereby, the knot corresponds to the key field of a conventional interpolator node; i.e., if the set_fraction value is within [0;1] and the knot vector within [0;2], only half of the curve is computed.

## Constructor & Destructor Documentation

NurbsPositionInterpolator | ( | const char * | name = `""` | ) |

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

      dimension = 0;
      order = 4;

~NurbsPositionInterpolator | ( |  | ) | `[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:

- dimension
- keyValue
- keyWeight
- knot
- order

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:

- 0 : dimension
- 1 : keyValue
- 2 : keyWeight
- 3 : knot
- 4 : order This function is useful, with nbFields() if you want to traverse all fields of a Node.

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:

- set_fraction
- set_dimension
- set_keyValue
- set_keyWeight
- set_knot
- set_order

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:

- 0 : set_fraction
- 1 : set_dimension
- 2 : set_keyValue
- 3 : set_keyWeight
- 4 : set_knot
- 5 : set_order

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:

- value_changed
- dimension_changed
- keyValue_changed
- keyWeight_changed
- knot_changed
- order_changed

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:

- 0 : value_changed
- 1 : dimension_changed
- 2 : keyValue_changed
- 3 : keyWeight_changed
- 4 : knot_changed
- 5 : order_changed This function is useful, with nbEventsOut() if you want to traverse all events in of a Node.

Implements Node.

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

Returns `"NurbsPositionInterpolator"`. 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

SFInt32 dimension

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

           dimension = 0;

MFVec3f keyValue

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

MFFloat keyWeight

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

MFFloat knot

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

SFInt32 order

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

           order = 4;

EventIn<SFFloat> set_fraction

See Detailed Description for meaning of this event.

EventIn<SFInt32> set_dimension

Set event associated to exposedField dimension

EventIn<MFVec3f> set_keyValue

Set event associated to exposedField keyValue

EventIn<MFFloat> set_keyWeight

Set event associated to exposedField keyWeight

EventIn<MFFloat> set_knot

Set event associated to exposedField knot

EventIn<SFInt32> set_order

Set event associated to exposedField order

EventOut<SFVec3f> value_changed

See Detailed Description for meaning of this event.

EventOut<SFInt32> dimension_changed

Changed event associated to exposedField dimension

EventOut<MFVec3f> keyValue_changed

Changed event associated to exposedField keyValue

EventOut<MFFloat> keyWeight_changed

Changed event associated to exposedField keyWeight

EventOut<MFFloat> knot_changed

Changed event associated to exposedField knot

EventOut<SFInt32> order_changed

Changed event associated to exposedField order

Generated on 5 Jan 2007 with version 1.5.1. |