com.visioglobe.libVisioDevKit

Class VgSplineVectorFunctorDescriptor

java.lang.Object

com.visioglobe.libVisioDevKit.VgReferenced

com.visioglobe.libVisioDevKit.VgFunctorDescriptor

com.visioglobe.libVisioDevKit.VgSplineVectorFunctorDescriptor

public class VgSplineVectorFunctorDescriptor
extends VgFunctorDescriptor

This class describes a functor that approximates a sequence of vectors with a spline. It also has the ability to specify a "distance from spline". It is the metric distance the animated object will be from the spline along it's negative Z axis.

Method Summary

Methods

Modifier and Type	Method and Description
static VgSplineVectorFunctorDescriptorRefPtr	create() This static method returns a new heap-allocated descriptor.
void	delete()
float	getMDistanceFromSpline() The distance at which we will place the animated object from the spline.
VgPositionVector	getMPoints() The vector of points of the spline
float	getMSplineMetricRadius() The maximal metric radius of the rounded angle at spline points
void	setMDistanceFromSpline(float value) The distance at which we will place the animated object from the spline.
void	setMPoints(VgPositionVector value) The vector of points of the spline
void	setMSplineMetricRadius(float value) The maximal metric radius of the rounded angle at spline points

Methods inherited from class com.visioglobe.libVisioDevKit.VgFunctorDescriptor

getMEndTime, getMStartTime, setMEndTime, setMStartTime

Methods inherited from class com.visioglobe.libVisioDevKit.VgReferenced

getNbReferences, ref, unref

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

delete

public void delete()

Overrides:

delete in class VgFunctorDescriptor

create

public static VgSplineVectorFunctorDescriptorRefPtr 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.

setMPoints

public void setMPoints(VgPositionVector value)

The vector of points of the spline

getMPoints

public VgPositionVector getMPoints()

The vector of points of the spline

setMSplineMetricRadius

public void setMSplineMetricRadius(float value)

The maximal metric radius of the rounded angle at spline points

getMSplineMetricRadius

public float getMSplineMetricRadius()

The maximal metric radius of the rounded angle at spline points

setMDistanceFromSpline

public void setMDistanceFromSpline(float value)

The distance at which we will place the animated object from the spline.

Remark:

this parameter is ignored if no orientation spline functor is used.

getMDistanceFromSpline

public float getMDistanceFromSpline()

The distance at which we will place the animated object from the spline.

Remark:

this parameter is ignored if no orientation spline functor is used.