VgSinusoidalVectorOffsetFunctorDescriptor Class Reference

Inheritance diagram for VgSinusoidalVectorOffsetFunctorDescriptor:

Public Member Functions
void	setMBaseVector (float[] value)
float[]	getMBaseVector ()
void	setMVector (float[] value)
float[]	getMVector ()
void	setMStartPhase (double value)
double	getMStartPhase ()
void	setMEndPhase (double value)
double	getMEndPhase ()
Public Member Functions inherited from VgFunctorDescriptor
void	setMStartTime (float value)
float	getMStartTime ()
void	setMEndTime (float value)
float	getMEndTime ()
Public Member Functions inherited from VgReferenced
synchronized void	release ()
	VgReferenced ()
	VgReferenced (VgReferenced pThis)
void	ref ()
int	unref ()
int	getNbReferences ()

Static Public Member Functions
static VgSinusoidalVectorOffsetFunctorDescriptorRefPtr	create ()

Detailed Description

This class implements descriptors for sinusoidal animation of vectors. The sinusoidal vector animation will apply an offset vector weighted by a sinusoidal time-dependent function. The functors described by this class can be used for all animations channels that manage vectors as values. Formula is the following : f(t) = mBaseVector + sin(mStartPhase + t/mDuration * (mEndPhase-mStartPhase)) * mOffsetVector.

Note

There is no period (or frequency) parameter in this descriptor, because it will be deduced from the start/end phase and the animation duration.

The valid range for phase parameters is [-inf, +inf], but the precision will be (a lot) better for values around 0. To get a full sine cycle start phase should be 0 and the end phase 2 * Pi. To get more pulsations the range should be widened, but it is better to use [-phase, +phase] than [0, 2*phase]

Version

2.0.7729

Member Function Documentation

static VgSinusoidalVectorOffsetFunctorDescriptorRefPtr VgSinusoidalVectorOffsetFunctorDescriptor.create ( )

static

This static method returns a new heap-allocated descriptor. It is the only method that should be used to instantiate new descriptors. It is a way to make sure no one will delete it, except the last VgRefPtr pointing to it.

float [] VgSinusoidalVectorOffsetFunctorDescriptor.getMBaseVector

(

)

double VgSinusoidalVectorOffsetFunctorDescriptor.getMEndPhase

(

)

double VgSinusoidalVectorOffsetFunctorDescriptor.getMStartPhase

(

)

float [] VgSinusoidalVectorOffsetFunctorDescriptor.getMVector

(

)

void VgSinusoidalVectorOffsetFunctorDescriptor.setMBaseVector

(

float[]

value

)

void VgSinusoidalVectorOffsetFunctorDescriptor.setMEndPhase

(

double

value

)

void VgSinusoidalVectorOffsetFunctorDescriptor.setMStartPhase

(

double

value

)

void VgSinusoidalVectorOffsetFunctorDescriptor.setMVector

(

float[]

value

)

---

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

• VgSinusoidalVectorOffsetFunctorDescriptor.java