DX::IDXSurfaceDetail Struct Reference
#include <IDXSurfaceDetail.h>
Inherits DX::IDXMaterialOwned, DX::IDXModelOwned, and DX::IDXUserData.
List of all members.
Detailed Description
This controls surface detail options for this material map. It allows for control of billboard options.
Member Function Documentation
virtual DXError DXMCALL DX::IDXSurfaceDetail::AddMesh |
( |
const wchar_t * |
id |
) |
[pure virtual] |
Add a new mesh id to this surface detail. This should be in the form "index=id:options" (at time of writing (~3.1 beta ) ) For example : "1=gumtree:6"
- Parameters:
-
| id | The id of the mesh with an index and options |
- Returns:
- Error_NullParam if id was null.
Error_Success if the mesh was added.
virtual void DXMCALL DX::IDXSurfaceDetail::ClearMeshes |
( |
|
) |
[pure virtual] |
Remove all meshes from this Surface Detail. Always succeeds.
virtual DXError DXMCALL DX::IDXSurfaceDetail::CreateSurfaceDetailXYZ |
( |
IDXSurfaceDetailXYZPtr * |
out = 0 |
) |
[pure virtual] |
Create an IDXSurfaceDetailXYZ.
- Parameters:
-
| out | An optional pointer to an IDXSurfaceDetailXYZPtr where the result will be stored. |
- Returns:
- Error_Duplicate if there is already a surface detail.
Error_Success if the IDXSurfaceDetailXYZ was created and the result was stored in out.
virtual DXError DXMCALL DX::IDXSurfaceDetail::DestroySurfaceDetailXYZ |
( |
|
) |
[pure virtual] |
Destroy the IDXSurfaceDetailXYZ.
- Returns:
- Error_NotFound if there was no IDXSurfaceDetailXYZ found.
Error_Success if the IDXSurfaceDetailXYZ was destroyed.
virtual float DXMCALL DX::IDXSurfaceDetail::GetBillboardSize |
( |
|
) |
const [pure virtual] |
Get the base world size that the billboards will appear at. There will be some additional radnomisation on top.
virtual uint DXMCALL DX::IDXSurfaceDetail::GetBillboardSplit |
( |
|
) |
const [pure virtual] |
Get the number of squares that the billboard texture is being divided into.
virtual float DXMCALL DX::IDXSurfaceDetail::GetBillboardSway |
( |
|
) |
const [pure virtual] |
Get the sway value for the billboards. This controls how fast the billboards will sway.
virtual const wchar_t* DXMCALL DX::IDXSurfaceDetail::GetBillboardTexture |
( |
|
) |
const [pure virtual] |
Get the name of the texture that is being used as the billboard.
- Returns:
- The name of the texture. 0 if not set.
virtual const wchar_t* DXMCALL DX::IDXSurfaceDetail::GetLookupTexture |
( |
|
) |
const [pure virtual] |
Get the name of the texture that is being used as the lookup.
- Returns:
- The name of the texture.
virtual const wchar_t* DXMCALL DX::IDXSurfaceDetail::GetMesh |
( |
uint |
index |
) |
const [pure virtual] |
Get the mesh at the specified index.
- Parameters:
-
| index | The index of the mesh id to retrieve |
- Returns:
- A wchar_t* which is the id of the mesh, or 0 if the index was out of range. (May change soon)
virtual uint DXMCALL DX::IDXSurfaceDetail::GetNumMeshes |
( |
|
) |
const [pure virtual] |
Get the number of meshes that there are on the surface detail.
virtual DXError DXMCALL DX::IDXSurfaceDetail::GetSurfaceDetailXYZ |
( |
IDXSurfaceDetailXYZPtr * |
out |
) |
const [pure virtual] |
Get the IDXSurfaceDetailXYZ for this mesh.
- Parameters:
-
| A | point to an IDXSurfaceDetailXYZPtr where the result will be stored. |
- Returns:
- Error_NullParam if out was null.
Error_NotFound if there was not surface detail XYZ.
Error_Success if the result was stored in out.
virtual DXError DXMCALL DX::IDXSurfaceDetail::RemoveBillboardTexture |
( |
|
) |
[pure virtual] |
Remove the billboard texture from this surface detail.
- Returns:
- Error_NotFound if there was no texture to remove.
Error_Success if the texture was removed.
virtual DXError DXMCALL DX::IDXSurfaceDetail::RemoveLookupTexture |
( |
|
) |
[pure virtual] |
Remove the lookup texture from this surface detail.
- Returns:
- Error_NotFound if there was no texture to remove.
Error_Success if the texture was removed.
virtual DXError DXMCALL DX::IDXSurfaceDetail::RemoveMesh |
( |
uint |
start, |
|
|
uint |
count | |
|
) |
| | [pure virtual] |
Remove a range of mesh ids from the surface detail.
- 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::IDXSurfaceDetail::RemoveMesh |
( |
const wchar_t * |
id |
) |
[pure virtual] |
Remove the mesh with the specified id.
- Parameters:
-
| id | The id of the mesh to remove. |
- Returns:
- Error_NullParam if id was null.
Error_NotFound if there was no mesh id with the specified id.
Error_Success if the mesh was remvoed.
virtual DXError DXMCALL DX::IDXSurfaceDetail::RemoveMesh |
( |
uint |
index |
) |
[pure virtual] |
Remove the mesh id at the specified index.
- Parameters:
-
| Index | of mesh ID to remove. |
- Returns:
- Error_OutOfRange if index was out of range.
Error_Success if the mesh ID was removed.
virtual void DXMCALL DX::IDXSurfaceDetail::SetBillboardSize |
( |
float |
value |
) |
[pure virtual] |
Set the base world size that the billboards will be rendered at. This is further randomised at runtime.
virtual DXError DXMCALL DX::IDXSurfaceDetail::SetBillboardSplit |
( |
uint |
value |
) |
[pure virtual] |
Set the number of squares that the texture being used for the billboard texture is divided into. This must be a power of 2.
- Parameters:
-
| value | The new value for the split. |
- Returns:
- Error_InvalidParam if value was not a power of 2
virtual void DXMCALL DX::IDXSurfaceDetail::SetBillboardSway |
( |
float |
value |
) |
[pure virtual] |
Set the sway for the billboards. The higher the value, the more they will sway.
virtual DXError DXMCALL DX::IDXSurfaceDetail::SetBillboardTexture |
( |
const wchar_t * |
source |
) |
[pure virtual] |
Set the map that will be used for the billboards on this surface detail.
- Parameters:
-
| source | The name of the map that will be used. |
- Returns:
- Error_NullParam if source was null.
Error_Success if the source was set.
virtual DXError DXMCALL DX::IDXSurfaceDetail::SetLookupTexture |
( |
const wchar_t * |
source |
) |
[pure virtual] |
Set the map that will be used for the lookup on this surface detail.
- Parameters:
-
| source | The name of the map that will be used. |
- Returns:
- Error_NullParam if source was null.
Error_Success if the source was set.