dtDAL::ActorActorProperty Class Reference

This actor property represents an actor. More...

#include <enginepropertytypes.h>

Inheritance diagram for dtDAL::ActorActorProperty:

List of all members.

Public Member Functions
	ActorActorProperty (ActorProxy &actorProxy, const std::string &name, const std::string &label, Functor1< ActorProxy * > Set, Functor0Ret< dtCore::DeltaDrawable * > Get, const std::string &desiredActorClass="", const std::string &desc="", const std::string &groupName="")
virtual void	CopyFrom (const ActorProperty &otherProp)
	Copies an ActorActorProperty value to this one from the property specified.
void	SetValue (ActorProxy *value)
	Sets the value of this property by calling the set functor assigned to this property.
ActorProxy *	GetValue () const
	Gets the value proxy assiged to this property.
dtCore::DeltaDrawable *	GetRealActor ()
	Gets the drawable that this property is representing.
const dtCore::DeltaDrawable *	GetRealActor () const
	Gets the drawable that this property is representing.
virtual bool	FromString (const std::string &value)
	Sets the value of the property based on a string.
virtual const std::string	ToString () const
	Returns: a string version of the data.
const std::string &	GetDesiredActorClass () const
	Returns: the class of proxy this expects so that the UI can filter the list.
Protected Member Functions
virtual	~ActorActorProperty ()

---

Detailed Description

This actor property represents an actor.

---

Constructor & Destructor Documentation

dtDAL::ActorActorProperty::ActorActorProperty	(	ActorProxy &	actorProxy,
		const std::string &	name,
		const std::string &	label,
		Functor1< ActorProxy * >	Set,
		Functor0Ret< dtCore::DeltaDrawable * >	Get,
		const std::string &	desiredActorClass = "",
		const std::string &	desc = "",
		const std::string &	groupName = ""
	)			[inline]

virtual dtDAL::ActorActorProperty::~ActorActorProperty

(

)

[inline, protected, virtual]

---

Member Function Documentation

virtual void dtDAL::ActorActorProperty::CopyFrom

(

const ActorProperty &

otherProp

)

[inline, virtual]

Copies an ActorActorProperty value to this one from the property specified.

This method fails if otherProp is not a ResourceActorProperty.

Parameters:

otherProp

The property to copy the value from.

Implements dtDAL::ActorProperty.

void dtDAL::ActorActorProperty::SetValue

(

ActorProxy *

value

)

Sets the value of this property by calling the set functor assigned to this property.

Hack for the resource class

Parameters:

value

the value to set or NULL to clear it. The passed in pointer is not stored. The values are extracted and stored in a separate object.

ActorProxy * dtDAL::ActorActorProperty::GetValue

(

)

const

Gets the value proxy assiged to this property.

Hack for the resource class

Returns:

the currently set ActorProxy for this property.

dtCore::DeltaDrawable * dtDAL::ActorActorProperty::GetRealActor

(

)

Gets the drawable that this property is representing.

Returns:

The actor

const dtCore::DeltaDrawable * dtDAL::ActorActorProperty::GetRealActor

(

)

const

Gets the drawable that this property is representing.

Returns:

The actor

bool dtDAL::ActorActorProperty::FromString

(

const std::string &

value

)

[virtual]

Sets the value of the property based on a string.

The string should be the both the unique id and the display string separated by a comma.

Note:

Returns false it the property is read only

Parameters:

value

the value to set.

Returns:

false if the value does not reference an existing proxy or the proxy is of the wrong class.

Implements dtDAL::AbstractParameter.

const std::string dtDAL::ActorActorProperty::ToString

(

)

const [virtual]

Returns:

a string version of the data.

This value can be used when calling FromString.

See also:

FromString

Implements dtDAL::AbstractParameter.

const std::string& dtDAL::ActorActorProperty::GetDesiredActorClass

(

)

const [inline]

Returns:

the class of proxy this expects so that the UI can filter the list.

---