com.visioglobe.libVisioDevKit
Class VgAnimationDescriptor

java.lang.Object
  com.visioglobe.libVisioDevKit.VgReferenced
      com.visioglobe.libVisioDevKit.VgAnimationDescriptor

public class VgAnimationDescriptor
extends VgReferenced

This class implements descriptors for animations. This is the set of parameters that will allow animation instantiation.

Field Summary

Fields inherited from class com.visioglobe.libVisioDevKit.VgReferenced

swigCMemOwn, swigRefPtr

Constructor Summary

VgAnimationDescriptor(long cPtr, boolean cMemoryOwn)
This constructor will initialize an empty animation descriptor (no channel functor).

Method Summary

static VgAnimationDescriptorRefPtr	create() This static method returns a new heap-allocated descriptor.
void	delete()
static long	getCPtr(VgAnimationDescriptor obj)
VgIAnimationCallbackRefPtr	getMCallback() Pointer to the callback to notify when the animation finishes.
float	getMDuration() Animation duration in seconds (default is 1 second).
VgFunctorDescriptorMap	getMFunctorDescriptors() This map associates a spatial (by name) an animation target (by name) and a functor descriptor that will be used to instantiate the real functors.
long	getMLoopMode() Flag to set up a looping animation (default is no loop).
void	setMCallback(VgIAnimationCallbackRefPtr value) Pointer to the callback to notify when the animation finishes.
void	setMDuration(float value) Animation duration in seconds (default is 1 second).
void	setMFunctorDescriptors(VgFunctorDescriptorMap value) This map associates a spatial (by name) an animation target (by name) and a functor descriptor that will be used to instantiate the real functors.
void	setMLoopMode(long value) Flag to set up a looping animation (default is no loop).

Methods inherited from class com.visioglobe.libVisioDevKit.VgReferenced

finalize, getCPtr, getNbReferences, ref, unref

Methods inherited from class java.lang.Object

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

Constructor Detail

VgAnimationDescriptor

public VgAnimationDescriptor(long cPtr,
                             boolean cMemoryOwn)

This constructor will initialize an empty animation descriptor (no channel functor).

Method Detail

getCPtr

public static long getCPtr(VgAnimationDescriptor obj)

delete

public void delete()

Overrides:

delete in class VgReferenced

create

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

setMFunctorDescriptors

public void setMFunctorDescriptors(VgFunctorDescriptorMap value)

This map associates a spatial (by name) an animation target (by name) and a functor descriptor that will be used to instantiate the real functors. If the spatial's name is empty, it means it is the spatial hosting the animation. Standard target names are "position", "orientation", ... (see When a functor descriptor is added to this map, the ownership is left to the caller. It is the caller responsibility to delete it after animation instantiation.

getMFunctorDescriptors

public VgFunctorDescriptorMap getMFunctorDescriptors()

This map associates a spatial (by name) an animation target (by name) and a functor descriptor that will be used to instantiate the real functors. If the spatial's name is empty, it means it is the spatial hosting the animation. Standard target names are "position", "orientation", ... (see When a functor descriptor is added to this map, the ownership is left to the caller. It is the caller responsibility to delete it after animation instantiation.

setMDuration

public void setMDuration(float value)

Animation duration in seconds (default is 1 second).

getMDuration

public float getMDuration()

Animation duration in seconds (default is 1 second).

setMLoopMode

public void setMLoopMode(long value)

Flag to set up a looping animation (default is no loop).

getMLoopMode

public long getMLoopMode()

Flag to set up a looping animation (default is no loop).

setMCallback

public void setMCallback(VgIAnimationCallbackRefPtr value)

Pointer to the callback to notify when the animation finishes. The caller must free this pointer, the animation must be stopped and deleted before freeing the callback. If the mLoop flag is true, this callback will never get called, since the animation never finishes.

getMCallback

public VgIAnimationCallbackRefPtr getMCallback()

Pointer to the callback to notify when the animation finishes. The caller must free this pointer, the animation must be stopped and deleted before freeing the callback. If the mLoop flag is true, this callback will never get called, since the animation never finishes.