#include <IDXModel.h>
Inherits DX::IDXUserData.
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 |
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.
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. |
virtual DXError DXMCALL DX::IDXModel::CreateGroup | ( | const char * | id, | |
IDXGroupPtr * | out = 0 | |||
) | [pure virtual] |
Create a new top level group on this model.
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. |
virtual DXError DXMCALL DX::IDXModel::CreateMaterial | ( | const char * | id, | |
IDXMaterialPtr * | out = 0 | |||
) | [pure virtual] |
Create a new material and add it to the model.
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. |
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.
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. |
virtual DXError DXMCALL DX::IDXModel::GetAnimation | ( | const char * | id, | |
IDXAnimationPtr * | out | |||
) | const [pure virtual] |
Get the animation with the specified id.
id | The id to search for. | |
out | A pointer to an IDXAnimationPtr where the result will be stored. |
virtual DXError DXMCALL DX::IDXModel::GetAnimation | ( | uint | index, | |
IDXAnimationPtr * | out | |||
) | const [pure virtual] |
Get the animation at the specified index.
index | The index of the animation to retrieve. | |
out | A pointer to an IDXAnimationPtr where the result will be stored. |
virtual DXError DXMCALL DX::IDXModel::GetAnimationIndex | ( | IDXAnimationPtr | animation, | |
uint * | out | |||
) | const [pure virtual] |
Get the index of the specified animation.
animation | The animation to search for. | |
out | A pointer to a uint where the result will be stored. |
virtual DXError DXMCALL DX::IDXModel::GetAnimationIndex | ( | const char * | id, | |
uint * | out | |||
) | const [pure virtual] |
Get the index of the animation with the specified id.
id | The id of the animation to search for. | |
out | A pointer to a uint where the result will be stored. |
virtual DXError DXMCALL DX::IDXModel::GetAnimations | ( | uint | start, | |
uint | count, | |||
IDXAnimationArray | out | |||
) | const [pure virtual] |
Get a group of animations from this model.
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.
out | A user allocated array of IDXAnimationPtr of length at least GetNumAnimations |
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.
id | The id to find. | |
out | A pointer to an IDXGetGroupResultPtr which will store the results. | |
recurse | If true, thiswill scan all child groups. |
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.
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. |
virtual DXError DXMCALL DX::IDXModel::GetGroup | ( | uint | index, | |
IDXGroupPtr * | out | |||
) | const [pure virtual] |
Get the group at the specified index.
index | The index of the group to retrieve. | |
out | A pointer to an IDXGroupPtr where the result will be stored. |
virtual DXError DXMCALL DX::IDXModel::GetGroupIndex | ( | IDXGroupPtr | group, | |
uint * | out | |||
) | const [pure virtual] |
Get the index of the specified group.
group | The group to find. | |
out | A pointer to a uint where the result will be stored. |
virtual DXError DXMCALL DX::IDXModel::GetGroupIndex | ( | const char * | id, | |
uint * | out | |||
) | const [pure virtual] |
Get the index of the group with the specified id.
id | The id of the group to find. | |
out | A pointer to a uint where the result will be stored. |
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.
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. |
virtual DXError DXMCALL DX::IDXModel::GetGroups | ( | IDXGroupArray | out | ) | const [pure virtual] |
Get the groups which are direct children of this model.
out | A user allocated array of IDXGroupPtr of length at least GetNumGroups. |
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.
virtual DXError DXMCALL DX::IDXModel::GetMaterial | ( | const char * | id, | |
IDXMaterialPtr * | out | |||
) | const [pure virtual] |
Get the material with the specified id.
id | The id to search for. | |
out | A pointer to an IDXMaterialPtr to store the result. |
virtual DXError DXMCALL DX::IDXModel::GetMaterial | ( | uint | index, | |
IDXMaterialPtr * | out | |||
) | const [pure virtual] |
Get the material at the specified index.
index | The index of the material to retrieve. | |
out | A pointer to an IDXMaterialPtr to store the result. |
virtual DXError DXMCALL DX::IDXModel::GetMaterialIndex | ( | IDXMaterialPtr | material, | |
uint * | out | |||
) | const [pure virtual] |
Get the index of the material with the specified id.
material | An IDXMaterialPtr to search for. | |
out | A pointer to a uint where the index will be stored. |
virtual DXError DXMCALL DX::IDXModel::GetMaterialIndex | ( | const char * | id, | |
uint * | out | |||
) | const [pure virtual] |
Get the index of the material with the specified id.
id | The id to search for. | |
out | A pointer to a uint where the index will be stored. |
virtual DXError DXMCALL DX::IDXModel::GetMaterials | ( | uint | start, | |
uint | count, | |||
IDXMaterialArray | out | |||
) | const [pure virtual] |
Get a group of materials
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. |
virtual DXError DXMCALL DX::IDXModel::GetMaterials | ( | IDXMaterialArray | out | ) | const [pure virtual] |
Get all IDXMaterialPtr on this model.
out | A user allocated array of IDXMaterialPtr of length at least GetNumMaterials. |
virtual uint DXMCALL DX::IDXModel::GetNumAnimations | ( | ) | const [pure virtual] |
virtual uint DXMCALL DX::IDXModel::GetNumGroups | ( | ) | const [pure virtual] |
virtual uint DXMCALL DX::IDXModel::GetNumMaterials | ( | ) | const [pure virtual] |
virtual uint DXMCALL DX::IDXModel::GetNumUserTags | ( | ) | const [pure virtual] |
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.
virtual DXError DXMCALL DX::IDXModel::GetUserTag | ( | const wchar_t * | id, | |
IDXUserTagPtr * | out | |||
) | const [pure virtual] |
Get the first user tag with the specified id.
id | The id of the user tag to retrieve. | |
out | A pointer to an IDXUserTagPtr where the result will be stored. |
virtual DXError DXMCALL DX::IDXModel::GetUserTag | ( | uint | index, | |
IDXUserTagPtr * | out | |||
) | const [pure virtual] |
Get the user tag at the specified index.
index | The index of the IDXUserTag to retrieve. | |
out | A pointer to an IDXUserTagPtr where the result will be stored. |
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.
id | The id to serach for. | |
out | A pointer to a uint where the result will be stored. |
virtual DXError DXMCALL DX::IDXModel::GetUserTagIndex | ( | IDXUserTagPtr | tag, | |
uint * | out | |||
) | const [pure virtual] |
Get the index of the specified tag.
tag | The IDXUserTag to get the index of. | |
out | A pointer to a uint where the result will be stored. |
virtual DXError DXMCALL DX::IDXModel::GetUserTags | ( | uint | start, | |
uint | count, | |||
IDXUserTagArray | out | |||
) | const [pure virtual] |
Get a group of user tags from this model.
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. |
virtual DXError DXMCALL DX::IDXModel::GetUserTags | ( | IDXUserTagArray | out | ) | const [pure virtual] |
Get all user tags on this model.
out | A user allocated array of IDXUserTagPtr of length at least GetNumUserTags |
virtual DXError DXMCALL DX::IDXModel::LoadFromFile | ( | const wchar_t *const | filename, | |
DXLoadOptions | options = Load_Standard | |||
) | [pure virtual] |
Load a model from a .dxmesh file.
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.
start | The index of the first element to remove. | |
count | The number of elements to remove. |
virtual DXError DXMCALL DX::IDXModel::RemoveAnimation | ( | uint | index | ) | [pure virtual] |
Remove the animation at the specified index from the model.
index | The index of the animation to remove. |
virtual DXError DXMCALL DX::IDXModel::RemoveAnimation | ( | IDXAnimationPtr | animation | ) | [pure virtual] |
Remove the specified animation from the model.
animation | The animation to remove. |
virtual DXError DXMCALL DX::IDXModel::RemoveAnimation | ( | const char * | id | ) | [pure virtual] |
Remove the animation with the specified id from the model.
id | The id of the animation to remove. |
virtual DXError DXMCALL DX::IDXModel::RemoveGroup | ( | uint | start, | |
uint | count | |||
) | [pure virtual] |
Remove a range of groups from the model.
start | The index of the first element to remove. | |
count | The number of elements to remove. |
virtual DXError DXMCALL DX::IDXModel::RemoveGroup | ( | uint | index | ) | [pure virtual] |
Remove the group at the specified index from the model.
index | The index of the group to remove. |
virtual DXError DXMCALL DX::IDXModel::RemoveGroup | ( | IDXGroupPtr | group, | |
bool | recurse = false | |||
) | [pure virtual] |
Removes the specfied group from the model.
group | The group to remove. | |
recurse | Set to true if you want to search child groups for this group. |
virtual DXError DXMCALL DX::IDXModel::RemoveGroup | ( | const char * | id, | |
bool | recurse = false | |||
) | [pure virtual] |
Remove the group with the specified id from the model.
id | The id of the group to remove. | |
recurse | Set to true if you want to search child groups for the group. |
virtual DXError DXMCALL DX::IDXModel::RemoveMaterial | ( | uint | start, | |
uint | count | |||
) | [pure virtual] |
Remove a range of materials from the model.
start | The index of the first element to remove. | |
count | The number of elements to remove. |
virtual DXError DXMCALL DX::IDXModel::RemoveMaterial | ( | uint | index | ) | [pure virtual] |
Remove the material at the specified index from the model.
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.
material | The material to remove from the model. |
virtual DXError DXMCALL DX::IDXModel::RemoveMaterial | ( | const char * | id | ) | [pure virtual] |
Remove the material with the specified id from the model.
id | The id of the material to remove. |
virtual DXError DXMCALL DX::IDXModel::RemoveUserTag | ( | IDXUserTagPtr | tag | ) | [pure virtual] |
Remove the specified IDXUserTag.
tag | The IDXUserTag to remove. |
virtual DXError DXMCALL DX::IDXModel::RemoveUserTag | ( | uint | start, | |
uint | count | |||
) | [pure virtual] |
Remove a range of IDXUserTag.
start | The index of the first element to remove. | |
count | The number of elements to remove. |
virtual DXError DXMCALL DX::IDXModel::RemoveUserTag | ( | const wchar_t * | id | ) | [pure virtual] |
Remove the first IDXUserTag with the specified id.
id | The id to search for. |
virtual DXError DXMCALL DX::IDXModel::RemoveUserTag | ( | uint | index | ) | [pure virtual] |
Remove the IDXUserTag at the specified index.
index | The index of the IDXUserTag to remove. |
virtual DXError DXMCALL DX::IDXModel::SaveToFile | ( | const wchar_t *const | filename | ) | [pure virtual] |
Save the model to the specified filename.
filename | The location to save the model to. |