com.visioglobe.libVisioDevKit
Class VgAxialRotationQuaternionFunctorDescriptor

java.lang.Object
  com.visioglobe.libVisioDevKit.VgReferenced
      com.visioglobe.libVisioDevKit.VgFunctorDescriptor
          com.visioglobe.libVisioDevKit.VgAxialRotationQuaternionFunctorDescriptor

public class VgAxialRotationQuaternionFunctorDescriptor
extends VgFunctorDescriptor

This class implements descriptors for axial rotation functors. It will simply interpolate between two angle values and apply rotation of the given angle along the axis. It is possible to set the functor to use a cubic function to have acceleration at start and deceleration at end. There is a possibility of setting a fixed pre-orientation value that will be applied prior to the interpolation's value.

Field Summary

Fields inherited from class com.visioglobe.libVisioDevKit.VgReferenced

swigCMemOwn, swigRefPtr

Constructor Summary

VgAxialRotationQuaternionFunctorDescriptor(long cPtr, boolean cMemoryOwn)
Class constructor.

Method Summary

static VgAxialRotationQuaternionFunctorDescriptorRefPtr	create() This static method returns a new heap-allocated descriptor.
void	delete()
static long	getCPtr(VgAxialRotationQuaternionFunctorDescriptor obj)
float[]	getMAxis() The rotation axis.
boolean	getMCubic() This boolean value tells whether a cubic function should be used to add acceleration and deceleration (true) or pure linear with constant velocity (false).
float	getMEndAngle() This is the target rotation angle (in degrees).
VgOrientation	getMPreOrientation() The pre-orientation value.
float	getMStartAngle() This is the starting rotation angle (in degrees).
void	setMAxis(float[] value) The rotation axis.
void	setMCubic(boolean value) This boolean value tells whether a cubic function should be used to add acceleration and deceleration (true) or pure linear with constant velocity (false).
void	setMEndAngle(float value) This is the target rotation angle (in degrees).
void	setMPreOrientation(VgOrientation value) The pre-orientation value.
void	setMStartAngle(float value) This is the starting rotation angle (in degrees).

Methods inherited from class com.visioglobe.libVisioDevKit.VgFunctorDescriptor

finalize, getCPtr, getMEndTime, getMStartTime, setMEndTime, setMStartTime

Methods inherited from class com.visioglobe.libVisioDevKit.VgReferenced

getCPtr, getNbReferences, ref, unref

Methods inherited from class java.lang.Object

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

Constructor Detail

VgAxialRotationQuaternionFunctorDescriptor

public VgAxialRotationQuaternionFunctorDescriptor(long cPtr,
                                                  boolean cMemoryOwn)

Class constructor. This can't be called publicly, instances must be obtained through the VgEngine::VgAxialRotationQuaternionFunctorDescriptor::create method.

Method Detail

getCPtr

public static long getCPtr(VgAxialRotationQuaternionFunctorDescriptor obj)

delete

public void delete()

Overrides:

delete in class VgFunctorDescriptor

create

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

setMPreOrientation

public void setMPreOrientation(VgOrientation value)

The pre-orientation value. This will be applied each time the functor is evaluated, before the interpolated orientation.

getMPreOrientation

public VgOrientation getMPreOrientation()

The pre-orientation value. This will be applied each time the functor is evaluated, before the interpolated orientation.

setMAxis

public void setMAxis(float[] value)

The rotation axis.

Warning:

If axis vector length is not long enough (below 1e-6), the functor creation will fail.

getMAxis

public float[] getMAxis()

The rotation axis.

Warning:

If axis vector length is not long enough (below 1e-6), the functor creation will fail.

setMStartAngle

public void setMStartAngle(float value)

This is the starting rotation angle (in degrees).

getMStartAngle

public float getMStartAngle()

This is the starting rotation angle (in degrees).

setMEndAngle

public void setMEndAngle(float value)

This is the target rotation angle (in degrees).

getMEndAngle

public float getMEndAngle()

This is the target rotation angle (in degrees).

setMCubic

public void setMCubic(boolean value)

This boolean value tells whether a cubic function should be used to add acceleration and deceleration (true) or pure linear with constant velocity (false).

getMCubic

public boolean getMCubic()

This boolean value tells whether a cubic function should be used to add acceleration and deceleration (true) or pure linear with constant velocity (false).