DX::IDXObjectProp Struct Reference
#include <IDXObjectProperty.h>
Inherits DX::IDXModelPropertiesOwned, DX::IDXModelOwned, and DX::IDXUserData.
List of all members.
|
Public Member Functions |
virtual const char *DXMCALL | GetID () const =0 |
virtual const char *DXMCALL | GetType () const =0 |
virtual uint DXMCALL | GetNumAttributes () const =0 |
virtual DXError DXMCALL | GetAttribute (uint index, IDXObjectPropAttributePtr *out) const =0 |
virtual DXError DXMCALL | GetAttribute (const char *id, IDXObjectPropAttributePtr *out) const =0 |
virtual DXError DXMCALL | GetAttributes (IDXObjectPropAttributeArray out) const =0 |
virtual DXError DXMCALL | GetAttributes (uint start, uint count, IDXObjectPropAttributeArray out) const =0 |
virtual DXError DXMCALL | SetID (const char *id)=0 |
virtual DXError DXMCALL | SetType (const char *type)=0 |
virtual DXError DXMCALL | AddAttribute (const char *id, const char *value)=0 |
virtual void DXMCALL | ClearAttributes ()=0 |
virtual DXError DXMCALL | RemoveAttribute (uint index)=0 |
virtual DXError DXMCALL | RemoveAttribute (uint start, uint count)=0 |
virtual DXError DXMCALL | RemoveAttribute (const char *id)=0 |
virtual DXError DXMCALL | RemoveAttribute (IDXObjectPropAttributePtr attribute)=0 |
Detailed Description
IDXObjectProp is used for default object properties on the model.
Member Function Documentation
virtual DXError DXMCALL DX::IDXObjectProp::AddAttribute |
( |
const char * |
id, |
|
|
const char * |
value | |
|
) |
| | [pure virtual] |
Add an attribute to this property.
- Parameters:
-
| The | id of the property. eg "x" |
| The | value of this property.eg "1.0451" |
- Returns:
- Error_NullParam if id was null.
Error_NullParam2 if value was null.
Error_InvalidParam if id contained invalid characters.
Error_Success if the attribute was added.
virtual void DXMCALL DX::IDXObjectProp::ClearAttributes |
( |
|
) |
[pure virtual] |
Remove all attributes on this prop
virtual DXError DXMCALL DX::IDXObjectProp::GetAttribute |
( |
const char * |
id, |
|
|
IDXObjectPropAttributePtr * |
out | |
|
) |
| | const [pure virtual] |
Get the first attribute with the specified id.
- Parameters:
-
| id | The id of the attribute to look for. |
| out | A pointer to an IDXObjectPropAttributePtr to receive the attribute. |
- Returns:
- Error_NullParam if out was null.
Error_NullParam2 if id was null.
Error_NotFound if there was no attribute with the specified id. Error_Success if the attribute was stored in out.
virtual DXError DXMCALL DX::IDXObjectProp::GetAttribute |
( |
uint |
index, |
|
|
IDXObjectPropAttributePtr * |
out | |
|
) |
| | const [pure virtual] |
Get the attribute at the specified index.
- Parameters:
-
| index | The index of the attribute to retrieve. |
| out | A pointer to an IDXObjectPropAttributePtr to receive the attribute. |
- Returns:
- Error_NullParam if out was null.
Error_OutOfRange if index was invalid.
Error_Success if the attribute was stored in out.
virtual DXError DXMCALL DX::IDXObjectProp::GetAttributes |
( |
uint |
start, |
|
|
uint |
count, |
|
|
IDXObjectPropAttributeArray |
out | |
|
) |
| | const [pure virtual] |
- Parameters:
-
| out | A user allocated array of IDXObjectPropAttributePtr 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::IDXObjectProp::GetAttributes |
( |
IDXObjectPropAttributeArray |
out |
) |
const [pure virtual] |
- Parameters:
-
| out | A user allocated array of IDXObjectPropAttributePtr of length at least GetNumAttributes |
- Returns:
- Error_NullParam if out was null.
Error_Success if the result was stored in out.
virtual const char* DXMCALL DX::IDXObjectProp::GetID |
( |
|
) |
const [pure virtual] |
Get the id of this property.
- Returns:
- The current ID.
virtual uint DXMCALL DX::IDXObjectProp::GetNumAttributes |
( |
|
) |
const [pure virtual] |
Get how many attributes this IDXObjectProp has.
- Returns:
- The number of attributes.
virtual const char* DXMCALL DX::IDXObjectProp::GetType |
( |
|
) |
const [pure virtual] |
Get the current type of the property. eg : "vector"
- Returns:
- The current type.
virtual DXError DXMCALL DX::IDXObjectProp::RemoveAttribute |
( |
IDXObjectPropAttributePtr |
attribute |
) |
[pure virtual] |
Remove the specified attribute.
- Parameters:
-
| attribute | The attribute to remove. |
- Returns:
- Error_NullParam if attribute was not null.
Error_NotFound if attribute was not found.
Error_Success if attribute was removed.
virtual DXError DXMCALL DX::IDXObjectProp::RemoveAttribute |
( |
const char * |
id |
) |
[pure virtual] |
Remove the attribute with the specified id.
- Parameters:
-
| id | The id of the attribute to remove. |
- Returns:
- Error_NullParam if id was null.
Error_NotFound if there was no attribute with this id. Error_Success if the attribute was removed.
virtual DXError DXMCALL DX::IDXObjectProp::RemoveAttribute |
( |
uint |
start, |
|
|
uint |
count | |
|
) |
| | [pure virtual] |
Remove a range of attributes from this prop.
- 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::IDXObjectProp::RemoveAttribute |
( |
uint |
index |
) |
[pure virtual] |
Remove the attribute at the specified index from this prop.
- Parameters:
-
| index | The index of the attribute to remove. |
- Returns:
- Error_OutOfRange if the index was invalid.
Error_Success if the attribute was removed.
virtual DXError DXMCALL DX::IDXObjectProp::SetID |
( |
const char * |
id |
) |
[pure virtual] |
Set the id field of this property.
- Parameters:
-
| id | The new ID for this property |
- Returns:
- Error_NullParam if id was null.
Error_Success if the id was set.
virtual DXError DXMCALL DX::IDXObjectProp::SetType |
( |
const char * |
type |
) |
[pure virtual] |
Set the type of the property.
- Parameters:
-
| type | The new type for this property. |
- Returns:
- Error_NullParam if type was null.
Error_Success if the type was changed.