dtActors::MeshTerrainActorProxy Class Reference

This proxy wraps mesh terrains. More...

#include <meshterrainactorproxy.h>

Inheritance diagram for dtActors::MeshTerrainActorProxy:

List of all members.

Public Member Functions
	MeshTerrainActorProxy ()
	Constructor.
virtual void	BuildPropertyMap ()
	Adds the properties that are common to all mesh terrain objects.
virtual void	LoadFile (const std::string &fileName)
	Loads a mesh file which contains terrain.
virtual const ActorProxy::RenderMode &	GetRenderMode ()
	Gets the method by which this terrain mesh is rendered.
virtual dtDAL::ActorProxyIcon *	GetBillBoardIcon ()
	Gets the billboard used to represent terrain meshes if this proxy's render mode is RenderMode::DRAW_BILLBOARD_ICON.
Protected Member Functions
virtual void	CreateActor ()
	Creates a mesh terrain instance.
virtual	~MeshTerrainActorProxy ()

---

Detailed Description

This proxy wraps mesh terrains.

---

Constructor & Destructor Documentation

dtActors::MeshTerrainActorProxy::MeshTerrainActorProxy

(

)

Constructor.

virtual dtActors::MeshTerrainActorProxy::~MeshTerrainActorProxy

(

)

[inline, protected, virtual]

---

Member Function Documentation

void dtActors::MeshTerrainActorProxy::BuildPropertyMap

(

)

[virtual]

Adds the properties that are common to all mesh terrain objects.

Reimplemented from dtActors::DeltaObjectActorProxy.

void dtActors::MeshTerrainActorProxy::LoadFile

(

const std::string &

fileName

)

[virtual]

Loads a mesh file which contains terrain.

Parameters:

fileName

The file of the terrain mesh to load.

Note:

Although terrain meshes are the same "type" of file as static meshes and other geometry, mesh terrains have a special resource of type DataType::TERRAIN.

Implements dtActors::DeltaObjectActorProxy.

const dtDAL::ActorProxy::RenderMode & dtActors::MeshTerrainActorProxy::GetRenderMode

(

)

[virtual]

Gets the method by which this terrain mesh is rendered.

Returns:

If there is no geometry currently assigned, this method will return RenderMode::DRAW_BILLBOARD_ICON. If there is geometry assigned to this static mesh, RenderMode::DRAW_ACTOR is returned.

Reimplemented from dtDAL::ActorProxy.

dtDAL::ActorProxyIcon * dtActors::MeshTerrainActorProxy::GetBillBoardIcon

(

)

[virtual]

Gets the billboard used to represent terrain meshes if this proxy's render mode is RenderMode::DRAW_BILLBOARD_ICON.

Returns:

Reimplemented from dtDAL::ActorProxy.

void dtActors::MeshTerrainActorProxy::CreateActor

(

)

[protected, virtual]

Creates a mesh terrain instance.

Reimplemented from dtActors::DeltaObjectActorProxy.

---