Package com.ms.com.directX

Previous

Microsoft Packages

Index

Next

Class d3drmAnimationSet

Applications use the methods of the d3drmAnimationSet class to group d3drmAnimation objects together, which can simplify the playback of complex animation sequences.

public class d3drmAnimationSet implements Id3drmAnimationSet
{
  public void InternalSetObject(IUnknown lpdd);
  public IUnknown InternalGetObject();
  public void AddDestroyCallback(Id3drmCallback fn, IUnknown Arg);
  public void DeleteDestroyCallback(Id3drmCallback fn, IUnknown args);
  public d3drmAnimationSet Clone();
  public void SetAppData(int data);
  public int GetAppData();
  public void SetName(String name);
  public String GetName();
  public String GetClassName();
  public void AddAnimation(d3drmAnimation aid);
  public void LoadFromFileByPos(String filename, int position, int flags, ILoadTextureCallback c, IUnknown pUser, d3drmFrame f);
  public void DeleteAnimation(d3drmAnimation aid);
  public void SetTime(float time);
}

The methods can be organized into the following groups:

Adding, loading, and removing	AddAnimation
	DeleteAnimation
	LoadFromFileByPos
Time	SetTime

In addition, the d3drmAnimationSet class inherits the following methods from the d3drmObject class:

AddDestroyCallback

Clone

DeleteDestroyCallback

GetAppData

GetClassName

GetName

SetAppData

SetName

The d3drmAnimationSet object is obtained by calling the CreateAnimationSet method.

AddAnimation

public void AddAnimation(d3drmAnimation aid);

Adds an animation to the animation set.

Return Value:

No return value.

Parameter	Description
aid	The d3drmAnimation object to be added to the animation set.

DeleteAnimation

public void DeleteAnimation(d3drmAnimation aid);

Removes a previously added animation from the animation set.

Return Value:

No return value.

Parameter	Description
aid	The d3drmAnimation object to be removed from the animation set.

LoadFromFileByPos

public void LoadFromFileByPos(String filename, int position, int flags, ILoadTextureCallback c, IUnknown pUser, d3drmFrame f);

Loads an animation set.

Return Value:

No return value.

Parameter	Description
filename	Name of file from which the object is to be loaded.
position	Position in file to be loaded from. The value gives the object's order in the file. This parameter can be null.
flags	A load options type.
c	Callback interface that contains the load texture callback function called to load any textures used by the object that require special formatting. This parameter can be null.
pUser	Application-defined data passed to the load texture callback function.
f	Parent d3drmFrame object. This prevents the frames referred to by the animation set from being created with a null parent.

Remarks:

By default, this method loads the first animation set in the file specified by the lpvObjSource parameter.

SetTime

public void SetTime(float time);

Sets the time for this animation set.

Return Value:

No return value.

Parameter	Description
time	New time.