dtDAL::ResourceActorProperty Class Reference

This actor property represents a resource. More...

#include <enginepropertytypes.h>

Inheritance diagram for dtDAL::ResourceActorProperty:

List of all members.

Public Member Functions
	ResourceActorProperty (ActorProxy &actorProxy, DataType &type, const std::string &name, const std::string &label, Functor1< const std::string & > Set, const std::string &desc="", const std::string &groupName="")
virtual void	CopyFrom (const ActorProperty &otherProp)
	Copies a ResourceActorProperty value to this one from the property specified.
void	SetValue (ResourceDescriptor *value)
	Sets the value of this property by calling the set functor assigned to this property.
ResourceDescriptor *	GetValue () const
	Gets the value of this property be calling the get functor assigned to this property.
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.
Protected Member Functions
virtual	~ResourceActorProperty ()

---

Detailed Description

This actor property represents a resource.

---

Constructor & Destructor Documentation

dtDAL::ResourceActorProperty::ResourceActorProperty	(	ActorProxy &	actorProxy,
		DataType &	type,
		const std::string &	name,
		const std::string &	label,
		Functor1< const std::string & >	Set,
		const std::string &	desc = "",
		const std::string &	groupName = ""
	)			[inline]

virtual dtDAL::ResourceActorProperty::~ResourceActorProperty

(

)

[inline, protected, virtual]

---

Member Function Documentation

virtual void dtDAL::ResourceActorProperty::CopyFrom

(

const ActorProperty &

otherProp

)

[inline, virtual]

Copies a ResourceActorProperty 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::ResourceActorProperty::SetValue

(

ResourceDescriptor *

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.

ResourceDescriptor * dtDAL::ResourceActorProperty::GetValue

(

)

const

Gets the value of this property be calling the get functor assigned to this property.

Hack for the resource class

Returns:

the currently set ResourceDescriptor for this property.

bool dtDAL::ResourceActorProperty::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 of the value is not valid.

Implements dtDAL::AbstractParameter.

const std::string dtDAL::ResourceActorProperty::ToString

(

)

const [virtual]

Returns:

a string version of the data.

This value can be used when calling FromString.

See also:

FromString

Implements dtDAL::AbstractParameter.

---