VgSinusoidalVectorOffsetFunctorDescriptorRefPtr Class Reference

Public Member Functions
	VgSinusoidalVectorOffsetFunctorDescriptorRefPtr ()
	VgSinusoidalVectorOffsetFunctorDescriptorRefPtr (VgSinusoidalVectorOffsetFunctorDescriptor pPointer)
	VgSinusoidalVectorOffsetFunctorDescriptorRefPtr (VgSinusoidalVectorOffsetFunctorDescriptorRefPtr pRefPtr)
VgSinusoidalVectorOffsetFunctorDescriptorRefPtr	set (VgSinusoidalVectorOffsetFunctorDescriptor pPointer)
VgSinusoidalVectorOffsetFunctorDescriptor	__ref__ ()
VgSinusoidalVectorOffsetFunctorDescriptor	__deref__ ()
VgSinusoidalVectorOffsetFunctorDescriptor	get ()
boolean	isValid ()
VgSinusoidalVectorOffsetFunctorDescriptorRefPtr	create ()
void	setMBaseVector (float[] value)
float[]	getMBaseVector ()
void	setMVector (float[] value)
float[]	getMVector ()
void	setMStartPhase (double value)
double	getMStartPhase ()
void	setMEndPhase (double value)
double	getMEndPhase ()
void	setMStartTime (float value)
float	getMStartTime ()
void	setMEndTime (float value)
float	getMEndTime ()
void	ref ()
int	unref ()
int	getNbReferences ()

Static Public Member Functions
static VgSinusoidalVectorOffsetFunctorDescriptorRefPtr	getNull ()

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

Constructor & Destructor Documentation

VgSinusoidalVectorOffsetFunctorDescriptorRefPtr.VgSinusoidalVectorOffsetFunctorDescriptorRefPtr

(

)

VgSinusoidalVectorOffsetFunctorDescriptorRefPtr.VgSinusoidalVectorOffsetFunctorDescriptorRefPtr

(

VgSinusoidalVectorOffsetFunctorDescriptor

pPointer

)

VgSinusoidalVectorOffsetFunctorDescriptorRefPtr.VgSinusoidalVectorOffsetFunctorDescriptorRefPtr

(

VgSinusoidalVectorOffsetFunctorDescriptorRefPtr

pRefPtr

)

Member Function Documentation

VgSinusoidalVectorOffsetFunctorDescriptor VgSinusoidalVectorOffsetFunctorDescriptorRefPtr.__deref__

(

)

VgSinusoidalVectorOffsetFunctorDescriptor VgSinusoidalVectorOffsetFunctorDescriptorRefPtr.__ref__

(

)

VgSinusoidalVectorOffsetFunctorDescriptorRefPtr VgSinusoidalVectorOffsetFunctorDescriptorRefPtr.create

(

)

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.

VgSinusoidalVectorOffsetFunctorDescriptor VgSinusoidalVectorOffsetFunctorDescriptorRefPtr.get

(

)

float [] VgSinusoidalVectorOffsetFunctorDescriptorRefPtr.getMBaseVector

(

)

double VgSinusoidalVectorOffsetFunctorDescriptorRefPtr.getMEndPhase

(

)

float VgSinusoidalVectorOffsetFunctorDescriptorRefPtr.getMEndTime

(

)

double VgSinusoidalVectorOffsetFunctorDescriptorRefPtr.getMStartPhase

(

)

float VgSinusoidalVectorOffsetFunctorDescriptorRefPtr.getMStartTime

(

)

float [] VgSinusoidalVectorOffsetFunctorDescriptorRefPtr.getMVector

(

)

int VgSinusoidalVectorOffsetFunctorDescriptorRefPtr.getNbReferences

(

)

static VgSinusoidalVectorOffsetFunctorDescriptorRefPtr VgSinusoidalVectorOffsetFunctorDescriptorRefPtr.getNull ( )

static

boolean VgSinusoidalVectorOffsetFunctorDescriptorRefPtr.isValid

(

)

void VgSinusoidalVectorOffsetFunctorDescriptorRefPtr.ref

(

)

VgSinusoidalVectorOffsetFunctorDescriptorRefPtr VgSinusoidalVectorOffsetFunctorDescriptorRefPtr.set

(

VgSinusoidalVectorOffsetFunctorDescriptor

pPointer

)

void VgSinusoidalVectorOffsetFunctorDescriptorRefPtr.setMBaseVector

(

float[]

value

)

void VgSinusoidalVectorOffsetFunctorDescriptorRefPtr.setMEndPhase

(

double

value

)

void VgSinusoidalVectorOffsetFunctorDescriptorRefPtr.setMEndTime

(

float

value

)

void VgSinusoidalVectorOffsetFunctorDescriptorRefPtr.setMStartPhase

(

double

value

)

void VgSinusoidalVectorOffsetFunctorDescriptorRefPtr.setMStartTime

(

float

value

)

void VgSinusoidalVectorOffsetFunctorDescriptorRefPtr.setMVector

(

float[]

value

)

int VgSinusoidalVectorOffsetFunctorDescriptorRefPtr.unref

(

)

---

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

• VgSinusoidalVectorOffsetFunctorDescriptorRefPtr.java