IDirect3DRMAnimationSet

Applications use the methods of the IDirect3DRMAnimationSet interface to group Direct3DRMAnimation objects together, which can simplify the playback of complex animation sequences. This section is a reference to the methods of this interface. For a conceptual overview, see IDirect3DRMAnimation and IDirect3DRMAnimationSet Interfaces.

The methods of the IDirect3DRMAnimationSet interface can be organized into the following groups:

Adding, loading,	AddAnimation
and removing	DeleteAnimation
	Load
Time	SetTime

The IDirect3DRMAnimationSet interface, like all Component Object Model (COM) interfaces, inherits the IUnknown interface methods. The IUnknown interface supports the following three methods:

AddRef

QueryInterface

Release

In addition, the IDirect3DRMAnimationSet interface inherits the following methods from the IDirect3DRMObject interface:

AddDestroyCallback

Clone

DeleteDestroyCallback

GetAppData

GetClassName

GetName

SetAppData

SetName

The Direct3DRMAnimationSet object is obtained by calling the IDirect3DRM::CreateAnimationSet method.

---

IDirect3DRMAnimationSet::AddAnimation

IDirect3DRMAnimationSet

Adds an animation to the animation set.

HRESULT AddAnimation(
  LPDIRECT3DRMANIMATION lpD3DRMAnimation
  );

Parameters

lpD3DRMAnimation

Address of the Direct3DRMAnimation object to be added to the animation set.

Return Values

Returns D3DRM_OK if successful, or an error otherwise. For a list of possible return codes, see Direct3D Retained Mode Return Values.

---

IDirect3DRMAnimationSet::DeleteAnimation

IDirect3DRMAnimationSet

Removes a previously added animation from the animation set.

HRESULT DeleteAnimation(
  LPDIRECT3DRMANIMATION lpD3DRMAnimation
  );

Parameters

lpD3DRMAnimation

Address of the Direct3DRMAnimation object to be removed from the animation set.

Return Values

Returns D3DRM_OK if successful, or an error otherwise. For a list of possible return codes, see Direct3D Retained Mode Return Values.

---

IDirect3DRMAnimationSet::Load

IDirect3DRMAnimationSet

Loads an animation set.

HRESULT Load(
  LPVOID lpvObjSource,
  LPVOID lpvObjID,
  D3DRMLOADOPTIONS d3drmLOFlags,
  D3DRMLOADTEXTURECALLBACK d3drmLoadTextureProc,
  LPVOID lpArgLTP,
  LPDIRECT3DRMFRAME lpParentFrame
  );

Parameters

lpvObjSource

Source for the object to be loaded. This source can be a file, resource, memory block, or stream, depending on the source flags specified in the d3drmLOFlags parameter.

lpvObjID

Object name or position to be loaded. The use of this parameter depends on the identifier flags specified in the d3drmLOFlags parameter. If the D3DRMLOAD_BYPOSITION flag is specified, this parameter is a pointer to a DWORD value that gives the object's order in the file. This parameter can be NULL.

d3drmLOFlags

Value of the D3DRMLOADOPTIONS type describing the load options.

d3drmLoadTextureProc

A D3DRMLOADTEXTURECALLBACK callback function used to load any textures used by the object that require special formatting. This parameter can be NULL.

lpArgLTP

Address of application-defined data passed to the D3DRMLOADTEXTURECALLBACK callback function.

lpParentFrame

Address of a parent Direct3DRMFrame object. This argument only affects the loading of animation sets. When an animation that is loaded from an .x file references an unparented frame in the .x file, the frame's parent is set to this parent frame argument. However, if you call Load to load any frames in the .x file, the parent frame argument will not be used as the parent frame for frames in the .x file with no parent. That is, the parent frame argument is used only when you load animation sets. The value of this argument can be NULL.

Return Values

Returns D3DRM_OK if successful, or an error otherwise. For a list of possible return codes, see Direct3D Retained Mode Return Values.

Remarks

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

---

IDirect3DRMAnimationSet::SetTime

IDirect3DRMAnimationSet

Sets the time for this animation set.

HRESULT SetTime(
  D3DVALUE rvTime
  );

Parameters

rvTime

New time.

Return Values

Returns D3DRM_OK if successful, or an error otherwise. For a list of possible return codes, see Direct3D Retained Mode Return Values.

© 1998 Microsoft Corporation. All rights reserved. Terms of Use.

Top of Page