DX::IDXSurfaceDetailXYZElement Struct Reference
#include <IDXSurfaceDetailXYZElement.H>
Inherits DX::IDXUserData.
List of all members.
|
Public Member Functions |
virtual DXXYZEntryType DXMCALL | GetType () const =0 |
virtual byte DXMCALL | GetSubType () const =0 |
virtual const DXVector &DXMCALL | GetPosition () const =0 |
virtual const DXVector &DXMCALL | GetScale () const =0 |
virtual const DXRotation &DXMCALL | GetRotation () const =0 |
virtual const DXVector &DXMCALL | GetNormal () const =0 |
virtual DXError DXMCALL | SetType (DXXYZEntryType type)=0 |
virtual void DXMCALL | SetSubtype (byte index)=0 |
virtual void DXMCALL | SetPosition (const DXVector &pos)=0 |
virtual void DXMCALL | SetScale (const DXVector &scale)=0 |
virtual void DXMCALL | SetRotation (const DXRotation &rotation)=0 |
virtual void DXMCALL | SetNormal (const DXVector &normal)=0 |
Detailed Description
This represents an entry in an xyz based surface detail map.
Member Function Documentation
virtual const DXVector& DXMCALL DX::IDXSurfaceDetailXYZElement::GetNormal |
( |
|
) |
const [pure virtual] |
Get the normal of the element.
- Returns:
- A DXVector which is the normal of the element.
virtual const DXVector& DXMCALL DX::IDXSurfaceDetailXYZElement::GetPosition |
( |
|
) |
const [pure virtual] |
Get the position of the element.
- Returns:
- A DXVector which is the position of the element.
virtual const DXRotation& DXMCALL DX::IDXSurfaceDetailXYZElement::GetRotation |
( |
|
) |
const [pure virtual] |
Get the rotation of the element.
- Returns:
- A DXRotation which is the rotation of the element.
virtual const DXVector& DXMCALL DX::IDXSurfaceDetailXYZElement::GetScale |
( |
|
) |
const [pure virtual] |
Get the scale of the element.
- Returns:
- A DXVector which is the scale of the element.
virtual byte DXMCALL DX::IDXSurfaceDetailXYZElement::GetSubType |
( |
|
) |
const [pure virtual] |
Get the subtype for this element.
- Returns:
- A byte which is the subtype index.
virtual DXXYZEntryType DXMCALL DX::IDXSurfaceDetailXYZElement::GetType |
( |
|
) |
const [pure virtual] |
Get the type of the XYZ Element.
- Returns:
- A member of the DXXYZEntryType enumeration.
virtual void DXMCALL DX::IDXSurfaceDetailXYZElement::SetNormal |
( |
const DXVector & |
normal |
) |
[pure virtual] |
Set the normal of the element.
- Parameters:
-
| pos | A DXVector which is the normal of the new element. |
virtual void DXMCALL DX::IDXSurfaceDetailXYZElement::SetPosition |
( |
const DXVector & |
pos |
) |
[pure virtual] |
Set the position of the element.
- Parameters:
-
| pos | A DXVector which is the position of the new element. |
virtual void DXMCALL DX::IDXSurfaceDetailXYZElement::SetRotation |
( |
const DXRotation & |
rotation |
) |
[pure virtual] |
Set the rotation of the element.
- Parameters:
-
| pos | A DXRotation which is the rotation of the new element. |
virtual void DXMCALL DX::IDXSurfaceDetailXYZElement::SetScale |
( |
const DXVector & |
scale |
) |
[pure virtual] |
Set the scale of the element.
- Parameters:
-
| pos | A DXVector which is the scale of the new element. |
virtual void DXMCALL DX::IDXSurfaceDetailXYZElement::SetSubtype |
( |
byte |
index |
) |
[pure virtual] |
Set the index into the type that will be used. (Eg, mesh id 3)
- Parameters:
-
virtual DXError DXMCALL DX::IDXSurfaceDetailXYZElement::SetType |
( |
DXXYZEntryType |
type |
) |
[pure virtual] |
Set the type of this XYZ Element.
- Parameters:
-
| type | A member of the DXXYZEntryType enumeration |
- Returns:
- Error_OutOfRange if type was greater than or equal to Type_Reserved
Error_Success if the type was updated.