H3D::X3DSequencerNode Class Reference
[Abstract nodes.]

This abstract node type is the base node type from which all Sequencers are derived. More...

#include <H3D/X3DSequencerNode.h>

Inheritance diagram for H3D::X3DSequencerNode:

Inheritance graph

List of all members.

Classes

class  KeyValues
 Each value in the keyValue field corresponds in order to the parameter value in the key field. More...
class  ValueChanged
 ValueChanged is a specialized class used to evaluate and set the value_changed field depending on the input to the class. More...

Public Member Functions

 X3DSequencerNode (Inst< SFNode > _metadata=0, Inst< SFBool > _next=0, Inst< SFBool > _previous=0, Inst< SFFloat > _set_fraction=0, Inst< MFFloat > _key=0)
 Constructor.

Public Attributes

auto_ptr< SFBoolnext
 Receipt of next event triggers next output value in keyValue array, next goes to initial element after last.
auto_ptr< SFBoolprevious
 Receipt of previous event triggers previous output value in keyValue array, previous goes to last element after first.
auto_ptr< SFFloatset_fraction
 The set_fraction inputOnly field receives an SFFloat event and causes the sequencing function to evaluate, resulting in a value_changed output event with the same timestamp as the set_fraction event.
auto_ptr< MFFloatkey
 Each value in the keyValue field corresponds in order to the parameter value in the key field.

Static Public Attributes

static H3DNodeDatabase database
 The H3DNodeDatabase for this node.


Detailed Description

This abstract node type is the base node type from which all Sequencers are derived.

The specified X3D sequencer nodes are designed for discrete events along a timeline. Each of these nodes defines a piecewise-linear function, f(t), on the interval (-infinity, +infinity). The piecewise-linear function is defined by n values of t, called key, and the n corresponding values of f(t), called keyValue. The keys shall be monotonically non-decreasing, otherwise the results are undefined. The keys are not restricted to any interval.

Each of these nodes evaluates f(t) given any value of t (via the fraction field) as follows: Let the n keys t0, t1, t2, ..., tn-1 partition the domain (-infinity, +infinity) into the n+1 subintervals given by (-infinity, t0), [t0, t1), [t1, t2), ... , [tn-1, +infinity). Also, let the n values v0, v1, v2, ..., vn-1 be the values of f(t) at the associated key values. The discrete value sequencing function, f(t), is defined to be:

f(t) = vn, if tn <= t < tn-1 = v0, if t <= t0, = vn-1, if t >= tn-1


Member Data Documentation

Each value in the keyValue field corresponds in order to the parameter value in the key field.

The keys shall be monotonically non-decreasing, otherwise the results are undefined. The keys are not restricted to any interval.

Access type: inputOutput
Default value: -

Receipt of next event triggers next output value in keyValue array, next goes to initial element after last.

Access type: inputOnly
Default value: -

Receipt of previous event triggers previous output value in keyValue array, previous goes to last element after first.

Access type: inputOnly
Default value: -

The set_fraction inputOnly field receives an SFFloat event and causes the sequencing function to evaluate, resulting in a value_changed output event with the same timestamp as the set_fraction event.

Access type: inputOnly
Default value: -


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

Generated on Fri Nov 7 10:31:30 2008 for H3D API by  doxygen 1.5.7