DX::IDXModel Struct Reference

#include <IDXModel.h>

Inherits DX::IDXUserData.

Collaboration diagram for DX::IDXModel:

Collaboration graph
[legend]

List of all members.

Public Member Functions

virtual uint DXMCALL GetNumMaterials () const =0
virtual uint DXMCALL GetNumGroups () const =0
virtual uint DXMCALL GetNumAnimations () const =0
virtual uint DXMCALL GetNumUserTags () const =0
virtual DXError DXMCALL GetMaterial (uint index, IDXMaterialPtr *out) const =0
virtual DXError DXMCALL GetMaterial (const char *id, IDXMaterialPtr *out) const =0
virtual DXError DXMCALL GetMaterials (IDXMaterialArray out) const =0
virtual DXError DXMCALL GetMaterials (uint start, uint count, IDXMaterialArray out) const =0
virtual DXError DXMCALL GetMaterialIndex (const char *id, uint *out) const =0
virtual DXError DXMCALL GetMaterialIndex (IDXMaterialPtr material, uint *out) const =0
virtual DXError DXMCALL GetGroup (uint index, IDXGroupPtr *out) const =0
virtual DXError DXMCALL GetGroup (const char *id, IDXGroupPtr *out, bool recurse=false) const =0
virtual DXError DXMCALL GetGroup (const char *id, IDXGetGroupResultPtr *out, bool recurse=false)=0
virtual DXError DXMCALL GetGroups (IDXGroupArray out) const =0
virtual DXError DXMCALL GetGroups (uint start, uint count, IDXGroupArray out) const =0
virtual DXError DXMCALL GetGroupIndex (const char *id, uint *out) const =0
virtual DXError DXMCALL GetGroupIndex (IDXGroupPtr group, uint *out) const =0
virtual DXError DXMCALL GetAnimation (uint index, IDXAnimationPtr *out) const =0
virtual DXError DXMCALL GetAnimation (const char *id, IDXAnimationPtr *out) const =0
virtual DXError DXMCALL GetAnimations (IDXAnimationArray out) const =0
virtual DXError DXMCALL GetAnimations (uint start, uint count, IDXAnimationArray out) const =0
virtual DXError DXMCALL GetAnimationIndex (const char *id, uint *out) const =0
virtual DXError DXMCALL GetAnimationIndex (IDXAnimationPtr animation, uint *out) const =0
virtual DXError DXMCALL GetUserTag (uint index, IDXUserTagPtr *out) const =0
virtual DXError DXMCALL GetUserTag (const wchar_t *id, IDXUserTagPtr *out) const =0
virtual DXError DXMCALL GetUserTags (IDXUserTagArray out) const =0
virtual DXError DXMCALL GetUserTags (uint start, uint count, IDXUserTagArray out) const =0
virtual DXError DXMCALL GetUserTagIndex (IDXUserTagPtr tag, uint *out) const =0
virtual DXError DXMCALL GetUserTagIndex (const wchar_t *id, uint *out) const =0
virtual IDXModelInfoPtr DXMCALL GetInfo () const =0
virtual IDXModelPropertiesPtr
DXMCALL 
GetProperties () const =0
virtual IDXFileSystemPtr DXMCALL GetFileSystem () const =0
virtual DXError DXMCALL CreateGroup (const char *id, IDXGroupPtr *out=0)=0
virtual DXError DXMCALL CreateAnimation (const char *id, float duration, float snap, bool autoplay, bool loop, IDXAnimationPtr *out=0)=0
virtual DXError DXMCALL CreateMaterial (const char *id, IDXMaterialPtr *out=0)=0
virtual DXError DXMCALL CreateUserTag (const wchar_t *id, const wchar_t *value, IDXUserTagPtr *out=0)=0
virtual DXError DXMCALL SaveToFile (const wchar_t *const filename)=0
virtual DXError DXMCALL LoadFromFile (const wchar_t *const filename, DXLoadOptions options=Load_Standard)=0
virtual DXError DXMCALL RemoveGroup (const char *id, bool recurse=false)=0
virtual DXError DXMCALL RemoveGroup (IDXGroupPtr group, bool recurse=false)=0
virtual DXError DXMCALL RemoveGroup (uint index)=0
virtual DXError DXMCALL RemoveGroup (uint start, uint count)=0
virtual void DXMCALL ClearGroups ()=0
virtual DXError DXMCALL RemoveAnimation (const char *id)=0
virtual DXError DXMCALL RemoveAnimation (IDXAnimationPtr animation)=0
virtual DXError DXMCALL RemoveAnimation (uint index)=0
virtual DXError DXMCALL RemoveAnimation (uint start, uint count)=0
virtual void DXMCALL ClearAnimations ()=0
virtual DXError DXMCALL RemoveMaterial (const char *id)=0
virtual DXError DXMCALL RemoveMaterial (IDXMaterialPtr material)=0
virtual DXError DXMCALL RemoveMaterial (uint index)=0
virtual DXError DXMCALL RemoveMaterial (uint start, uint count)=0
virtual void DXMCALL ClearMaterials ()=0
virtual DXError DXMCALL RemoveUserTag (uint index)=0
virtual DXError DXMCALL RemoveUserTag (const wchar_t *id)=0
virtual DXError DXMCALL RemoveUserTag (uint start, uint count)=0
virtual DXError DXMCALL RemoveUserTag (IDXUserTagPtr tag)=0
virtual void DXMCALL ClearUserTags ()=0
virtual void DXMCALL Optimize ()=0


Detailed Description

IDXModel is the main interface in the DXMeshAPI. It represents an entire model. It directly contains groups, animations and materials, and supports storage of relevant metadata.

Member Function Documentation

virtual void DXMCALL DX::IDXModel::ClearAnimations (  )  [pure virtual]

Remove all the animations from this model.

virtual void DXMCALL DX::IDXModel::ClearGroups (  )  [pure virtual]

Remove all the groups in this model.

virtual void DXMCALL DX::IDXModel::ClearMaterials (  )  [pure virtual]

Remove all materials from this model.

virtual void DXMCALL DX::IDXModel::ClearUserTags (  )  [pure virtual]

Remove all user tags from this model.

virtual DXError DXMCALL DX::IDXModel::CreateAnimation ( const char *  id,
float  duration,
float  snap,
bool  autoplay,
bool  loop,
IDXAnimationPtr *  out = 0 
) [pure virtual]

Create a new animation on this model.

Parameters:
id The name that will be used to refer to this animation in the API and also in javascript inside DXStudio.
duration The period of time that this animation will play for
snap This value is used by the editor to determine the interval at which keyframes can be added.
autoplay If this is true, then this animation will automatically play when the model is used by an object.
loop If this is true the animation will loop around when it reaches the end.
out Optional. A pointer to an IDXAnimationPtr which will be set to point to the newly added animation.
Returns:
Error_NullParam if id was null.
Error_InvalidParam if id contained invalid characters.
Error_Duplicate if an animation already exists with the same ID.
Error_Success if the animation was added successfully.
See also:
IDXAnimation

virtual DXError DXMCALL DX::IDXModel::CreateGroup ( const char *  id,
IDXGroupPtr *  out = 0 
) [pure virtual]

Create a new top level group on this model.

Parameters:
id The id that will be used to refer to this group in the API and in javascript inside DXStudio.
out An optional pointer to an IDXGroupPtr where a pointer to the new IDXGroupPtr will be saved.
Returns:
Error_NullParam if id was null.
Error_InvalidParam if id contained invalid characters.
Error_Success if the group was added successfully.
See also:
IDXGroup

virtual DXError DXMCALL DX::IDXModel::CreateMaterial ( const char *  id,
IDXMaterialPtr *  out = 0 
) [pure virtual]

Create a new material and add it to the model.

Parameters:
id The name that will be used to refer to the new material in the API and in script.
out Optional. A pointer to an IDXMaterialPtr variable where a pointer to the new material will be stored.
Returns:
Error_NullParam if id was null.
Error_InvalidParam if id contained invalid characters.
Error_Duplicate if a material with the same id already exists in this model.
Error_Success if the material was added successfully.
See also:
IDXMaterial

virtual DXError DXMCALL DX::IDXModel::CreateUserTag ( const wchar_t *  id,
const wchar_t *  value,
IDXUserTagPtr *  out = 0 
) [pure virtual]

Create a new usertag and add it to the model.

Parameters:
id The id that will be used for the tag.
value The value that will be used for the tag.
out An optional pointer to an IDXUserTagPtr variable where a pointer to the new material will be stored.
Returns:
Error_NullParam if id was null.
Error_NullParam2 if value was null.
Error_Success if the tag was added.

virtual DXError DXMCALL DX::IDXModel::GetAnimation ( const char *  id,
IDXAnimationPtr *  out 
) const [pure virtual]

Get the animation with the specified id.

Parameters:
id The id to search for.
out A pointer to an IDXAnimationPtr where the result will be stored.
Returns:
Error_NullParam if out was null.
Error_NullParam2 if id was null.
Error_NotFound if there was no animation with the specified id.
Error_Success if the result was stored in out.

virtual DXError DXMCALL DX::IDXModel::GetAnimation ( uint  index,
IDXAnimationPtr *  out 
) const [pure virtual]

Get the animation at the specified index.

Parameters:
index The index of the animation to retrieve.
out A pointer to an IDXAnimationPtr where the result will be stored.
Returns:
Error_NullParam if out was null.
Error_OutOfRange if index was out of range.
Error_Success if the result was stored in out.

virtual DXError DXMCALL DX::IDXModel::GetAnimationIndex ( IDXAnimationPtr  animation,
uint *  out 
) const [pure virtual]

Get the index of the specified animation.

Parameters:
animation The animation to search for.
out A pointer to a uint where the result will be stored.
Returns:
Error_NullParam if out was null.
Error_NullParam2 if animation was null.
Error_NotFound if the specified animation was not found.
Error_Success if the result was stored in out.

virtual DXError DXMCALL DX::IDXModel::GetAnimationIndex ( const char *  id,
uint *  out 
) const [pure virtual]

Get the index of the animation with the specified id.

Parameters:
id The id of the animation to search for.
out A pointer to a uint where the result will be stored.
Returns:
Error_NullParam if out was null.
Error_NullParam2 if id was null.
Error_NotFound if there was no animation with the specified id.
Error_Success if the result was stored in out.

virtual DXError DXMCALL DX::IDXModel::GetAnimations ( uint  start,
uint  count,
IDXAnimationArray  out 
) const [pure virtual]

Get a group of animations from this model.

Parameters:
start The index of the first element to retrieve.
count The number of elements to retrieve.
out A user allocated array of IDXAnimationPtr of length at least count.

virtual DXError DXMCALL DX::IDXModel::GetAnimations ( IDXAnimationArray  out  )  const [pure virtual]

Get all animations on this model.

Parameters:
out A user allocated array of IDXAnimationPtr of length at least GetNumAnimations
Returns:
Error_NullParam if out was null.
Error_Success if the result was stored in out.

virtual IDXFileSystemPtr DXMCALL DX::IDXModel::GetFileSystem (  )  const [pure virtual]

Get this model's IDXFileSystem. This allows you to manage the files that will be added to the zip, or to examine the files that have been loaded from a zip.

virtual DXError DXMCALL DX::IDXModel::GetGroup ( const char *  id,
IDXGetGroupResultPtr *  out,
bool  recurse = false 
) [pure virtual]

Get any groups with the specified id.

Parameters:
id The id to find.
out A pointer to an IDXGetGroupResultPtr which will store the results.
recurse If true, thiswill scan all child groups.
Returns:
Error_NullParam if out was null.
Error_NullParam2 if id was null.
Error_NotFound if there was no group found with the specfied id.
Error_Success if a number of groups were stored in out.

virtual DXError DXMCALL DX::IDXModel::GetGroup ( const char *  id,
IDXGroupPtr *  out,
bool  recurse = false 
) const [pure virtual]

Get the first group with the specified id.

Parameters:
id The id of the group to search for.
out A pointer to an IDXGroupPtr where the result will be stored.
recurse Set this to true to search through all subgroups.
Returns:
Error_NullParam if out was null.
Error_NullParam2 if id was null.
Error_NotFound if the group was not found.
Error_Success if the result was stored in out

virtual DXError DXMCALL DX::IDXModel::GetGroup ( uint  index,
IDXGroupPtr *  out 
) const [pure virtual]

Get the group at the specified index.

Parameters:
index The index of the group to retrieve.
out A pointer to an IDXGroupPtr where the result will be stored.
Returns:
Error_NullParam if out was null.
Error_OutOfRange if index was out of range.
Error_Success if the group was stored in out.

virtual DXError DXMCALL DX::IDXModel::GetGroupIndex ( IDXGroupPtr  group,
uint *  out 
) const [pure virtual]

Get the index of the specified group.

Parameters:
group The group to find.
out A pointer to a uint where the result will be stored.
Returns:
Error_NullParam if out was null.
Error_NullParam2 if id was null.
Error_NotFound if the group was not found.
Error_Success if the group was found and the result stored in out.

virtual DXError DXMCALL DX::IDXModel::GetGroupIndex ( const char *  id,
uint *  out 
) const [pure virtual]

Get the index of the group with the specified id.

Parameters:
id The id of the group to find.
out A pointer to a uint where the result will be stored.
Returns:
Error_NullParam if out was null.
Error_NullParam2 if id was null.
Error_NotFound if there was no group with the specified id.
Error_Success if the group was found and the result stored in out.

virtual DXError DXMCALL DX::IDXModel::GetGroups ( uint  start,
uint  count,
IDXGroupArray  out 
) const [pure virtual]

Get a block of groups which are direct children of this model.

Parameters:
start The index of the first element to retrieve.
count The number of elements to retrieve.
out A user allocated array of IDXGroupPtr of at least count where the result will be stored.
Returns:
Error_NullParam if out was null.
Error_OutOfRange if start was out of range.
Error_Success if the result was stored in out.

virtual DXError DXMCALL DX::IDXModel::GetGroups ( IDXGroupArray  out  )  const [pure virtual]

Get the groups which are direct children of this model.

Parameters:
out A user allocated array of IDXGroupPtr of length at least GetNumGroups.
Returns:
Error_NullParam if out was null.
Error_Success if the result was stored in out.

virtual IDXModelInfoPtr DXMCALL DX::IDXModel::GetInfo (  )  const [pure virtual]

Get the IDXModelInfoPtr for this IDXModel. Allows you to set properties such as title, summary and add tags, amongst other things.

Returns:
An IDXModelInfoPtr.

virtual DXError DXMCALL DX::IDXModel::GetMaterial ( const char *  id,
IDXMaterialPtr *  out 
) const [pure virtual]

Get the material with the specified id.

Parameters:
id The id to search for.
out A pointer to an IDXMaterialPtr to store the result.
Returns:
Error_NullParam if out was null.
Error_NullParam2 if id was null.
Error_NotFound if the material was not found.
Error_Success if the material was found and the result was stored in out.

virtual DXError DXMCALL DX::IDXModel::GetMaterial ( uint  index,
IDXMaterialPtr *  out 
) const [pure virtual]

Get the material at the specified index.

Parameters:
index The index of the material to retrieve.
out A pointer to an IDXMaterialPtr to store the result.
Returns:
Error_NullParam if out was null.
Error_OutOfRange if index was out of range.
Error_Success if the result was stored in out.

virtual DXError DXMCALL DX::IDXModel::GetMaterialIndex ( IDXMaterialPtr  material,
uint *  out 
) const [pure virtual]

Get the index of the material with the specified id.

Parameters:
material An IDXMaterialPtr to search for.
out A pointer to a uint where the index will be stored.
Returns:
Error_NullParam if out was null.
Error_NullParam2 if material was null.
Error_NotFound if the material was not found.
Error_Success if the material was found and the index stored in out.

virtual DXError DXMCALL DX::IDXModel::GetMaterialIndex ( const char *  id,
uint *  out 
) const [pure virtual]

Get the index of the material with the specified id.

Parameters:
id The id to search for.
out A pointer to a uint where the index will be stored.
Returns:
Error_NullParam if out was null.
Error_NullParam2 if id was null.
Error_NotFound if a material with the specified id was not found.
Error_Success if the material was found and the index stored in out.

virtual DXError DXMCALL DX::IDXModel::GetMaterials ( uint  start,
uint  count,
IDXMaterialArray  out 
) const [pure virtual]

Get a group of materials

Parameters:
start The index of the first element to retrieve.
count The number of elements to retrieve.
out A user allocated array of IDXMaterialPtr of length at least count.
Returns:
Error_NullParam if out was null.
Error_OutOfRange if start was out of range.
Error_Success if the result was stored in out.

virtual DXError DXMCALL DX::IDXModel::GetMaterials ( IDXMaterialArray  out  )  const [pure virtual]

Get all IDXMaterialPtr on this model.

Parameters:
out A user allocated array of IDXMaterialPtr of length at least GetNumMaterials.
Returns:
Error_NullParam if out was null.
Error_Success if the result was stored in out.

virtual uint DXMCALL DX::IDXModel::GetNumAnimations (  )  const [pure virtual]

Returns:
The number of animations that are in this model.

virtual uint DXMCALL DX::IDXModel::GetNumGroups (  )  const [pure virtual]

Returns:
The number of groups that are in this model.

virtual uint DXMCALL DX::IDXModel::GetNumMaterials (  )  const [pure virtual]

Returns:
The number of materials that are in this model.

virtual uint DXMCALL DX::IDXModel::GetNumUserTags (  )  const [pure virtual]

Returns:
The number of user tags in this model.

virtual IDXModelPropertiesPtr DXMCALL DX::IDXModel::GetProperties (  )  const [pure virtual]

Get the IDXModelPropertiesPtr for this IDXModel. Allows you to add default object properties, default script and so on.

Returns:
An IDXModelPropertiesPtr.

virtual DXError DXMCALL DX::IDXModel::GetUserTag ( const wchar_t *  id,
IDXUserTagPtr *  out 
) const [pure virtual]

Get the first user tag with the specified id.

Parameters:
id The id of the user tag to retrieve.
out A pointer to an IDXUserTagPtr where the result will be stored.
Returns:
Error_NullParam if out was null.
Error_NullParam2 if id was null.
Error_NotFound if the tag was not found.
Error_Success if the result was stored in out.

virtual DXError DXMCALL DX::IDXModel::GetUserTag ( uint  index,
IDXUserTagPtr *  out 
) const [pure virtual]

Get the user tag at the specified index.

Parameters:
index The index of the IDXUserTag to retrieve.
out A pointer to an IDXUserTagPtr where the result will be stored.
Returns:
Error_NullParam if out was null.
Error_OutOfRange if index was out of range.
Error_Success if the result was stored in out.

virtual DXError DXMCALL DX::IDXModel::GetUserTagIndex ( const wchar_t *  id,
uint *  out 
) const [pure virtual]

Get the index of the first tag with the specified id.

Parameters:
id The id to serach for.
out A pointer to a uint where the result will be stored.
Returns:
Error_NullParam if out was null.
Error_NullParam2 if id was null.
Error_NotFound if there was no tag with a matching ID. Error_Success if the result was stored in out.

virtual DXError DXMCALL DX::IDXModel::GetUserTagIndex ( IDXUserTagPtr  tag,
uint *  out 
) const [pure virtual]

Get the index of the specified tag.

Parameters:
tag The IDXUserTag to get the index of.
out A pointer to a uint where the result will be stored.
Returns:
Error_NullParam if out was null.
Error_NullParam2 if tag was null.
Error_NotFound if tag was not found in the model.
Error_Success if the result was stored in out.

virtual DXError DXMCALL DX::IDXModel::GetUserTags ( uint  start,
uint  count,
IDXUserTagArray  out 
) const [pure virtual]

Get a group of user tags from this model.

Parameters:
start The index of the first element to retrieve
count The number of elements to retrieve.
out A user allocated array of IDXUserTagPtr of length at least count.
Returns:
Error_NullParam if out was null.
Error_OutOfRange if start was out of range.
Error_Success if the result was stored in out.

virtual DXError DXMCALL DX::IDXModel::GetUserTags ( IDXUserTagArray  out  )  const [pure virtual]

Get all user tags on this model.

Parameters:
out A user allocated array of IDXUserTagPtr of length at least GetNumUserTags
Returns:
Error_NullParam if out was null.
Error_Success if the result was stored in out.

virtual DXError DXMCALL DX::IDXModel::LoadFromFile ( const wchar_t *const   filename,
DXLoadOptions  options = Load_Standard 
) [pure virtual]

Load a model from a .dxmesh file.

Parameters:
filename The location to load the model from.

virtual void DXMCALL DX::IDXModel::Optimize (  )  [pure virtual]

Sorts the faces in meshes to be in material order. This greatly improves rendering speed.

virtual DXError DXMCALL DX::IDXModel::RemoveAnimation ( uint  start,
uint  count 
) [pure virtual]

Remove a range of animations from the model.

Parameters:
start The index of the first element to remove.
count The number of elements to remove.
Returns:
Error_OutOfRange if start was out of range.
Error_Success if the range was removed.

virtual DXError DXMCALL DX::IDXModel::RemoveAnimation ( uint  index  )  [pure virtual]

Remove the animation at the specified index from the model.

Parameters:
index The index of the animation to remove.
Returns:
Error_OutOfRange if index was out of range.
Error_Success if the animation was removed successfully.

virtual DXError DXMCALL DX::IDXModel::RemoveAnimation ( IDXAnimationPtr  animation  )  [pure virtual]

Remove the specified animation from the model.

Parameters:
animation The animation to remove.
Returns:
Error_NullParam if animation was null.
Error_NotFound if animation was not found in this model.
Error_Success if the animation was removed from the model.

virtual DXError DXMCALL DX::IDXModel::RemoveAnimation ( const char *  id  )  [pure virtual]

Remove the animation with the specified id from the model.

Parameters:
id The id of the animation to remove.
Returns:
Error_NullParam if id was null.
Error_NotFound if there was no animation with the specified id.
Error_Success if the animation was removed.

virtual DXError DXMCALL DX::IDXModel::RemoveGroup ( uint  start,
uint  count 
) [pure virtual]

Remove a range of groups from the model.

Parameters:
start The index of the first element to remove.
count The number of elements to remove.
Returns:
Error_OutOfRange if start was out of range.
Error_Success if the range was removed.

virtual DXError DXMCALL DX::IDXModel::RemoveGroup ( uint  index  )  [pure virtual]

Remove the group at the specified index from the model.

Parameters:
index The index of the group to remove.
Returns:
Error_OutOfRange if index was out of range.
Error_Success if the group was removed.

virtual DXError DXMCALL DX::IDXModel::RemoveGroup ( IDXGroupPtr  group,
bool  recurse = false 
) [pure virtual]

Removes the specfied group from the model.

Parameters:
group The group to remove.
recurse Set to true if you want to search child groups for this group.
Returns:
Error_NullParam if group was null.
Error_NotFound if the group was not found.
Error_Success if the group was removed.

virtual DXError DXMCALL DX::IDXModel::RemoveGroup ( const char *  id,
bool  recurse = false 
) [pure virtual]

Remove the group with the specified id from the model.

Parameters:
id The id of the group to remove.
recurse Set to true if you want to search child groups for the group.
Returns:
Error_NullParam if id was null.
Error_NotFound if there was no group with the specified id.
Error_Success if the group was removed.

virtual DXError DXMCALL DX::IDXModel::RemoveMaterial ( uint  start,
uint  count 
) [pure virtual]

Remove a range of materials from the model.

Parameters:
start The index of the first element to remove.
count The number of elements to remove.
Returns:
Error_OutOfRange if start was out of range.
Error_Success if the range was removed.

virtual DXError DXMCALL DX::IDXModel::RemoveMaterial ( uint  index  )  [pure virtual]

Remove the material at the specified index from the model.

Parameters:
index The index of the material to remove.
Error_OutOfRange if index was out of range.
Error_Success if the material was removed.

virtual DXError DXMCALL DX::IDXModel::RemoveMaterial ( IDXMaterialPtr  material  )  [pure virtual]

Remove the specified material from the Model.

Parameters:
material The material to remove from the model.
Returns:
Error_NullParam if material was null.
Error_NotFound if the material was not found on the model.
Error_Success if the material was removed.

virtual DXError DXMCALL DX::IDXModel::RemoveMaterial ( const char *  id  )  [pure virtual]

Remove the material with the specified id from the model.

Parameters:
id The id of the material to remove.
Returns:
Error_NullParam if id was null.
Error_NotFound if there was no material with the specified id on the model.
Error_Success if the material was removed.

virtual DXError DXMCALL DX::IDXModel::RemoveUserTag ( IDXUserTagPtr  tag  )  [pure virtual]

Remove the specified IDXUserTag.

Parameters:
tag The IDXUserTag to remove.
Returns:
Error_NullParam if tag was null.
Error_NotFound if tag was not found in the model.
Error_Success if the tag was removed.

virtual DXError DXMCALL DX::IDXModel::RemoveUserTag ( uint  start,
uint  count 
) [pure virtual]

Remove a range of IDXUserTag.

Parameters:
start The index of the first element to remove.
count The number of elements to remove.
Returns:
Error_OutOfRange if start was out of range.
Error_Success if the range was removed.

virtual DXError DXMCALL DX::IDXModel::RemoveUserTag ( const wchar_t *  id  )  [pure virtual]

Remove the first IDXUserTag with the specified id.

Parameters:
id The id to search for.
Returns:
Error_NullParam if id was null.
Error_NotFound if there was no tag with matching id.
Error_Success if the tag was removed.

virtual DXError DXMCALL DX::IDXModel::RemoveUserTag ( uint  index  )  [pure virtual]

Remove the IDXUserTag at the specified index.

Parameters:
index The index of the IDXUserTag to remove.
Returns:
Error_OutOfRange if index was out of range.
Error_Success if the IDXUserTag was removed.

virtual DXError DXMCALL DX::IDXModel::SaveToFile ( const wchar_t *const   filename  )  [pure virtual]

Save the model to the specified filename.

Parameters:
filename The location to save the model to.
Returns:
Error_NullParam if filename was null.
Error_Success if the model was saved successfully.


Generated on Wed Jun 17 17:24:51 2009 for DXMesh API by  doxygen 1.5.7.1