DtArtPartsAdmin Class Reference

Admin content which contains the list of art parts, their parameters, and limits for a particular entity. More...

Inheritance diagram for DtArtPartsAdmin:

Classes
struct	CurrentMinAndMax

Public Types
typedef std::map< int, CurrentMinAndMax >	ParamInfo
typedef std::map< int, ParamInfo >	PartParamInfo

Public Member Functions
	DtArtPartsAdmin ()
	default constructor More...
	DtArtPartsAdmin (const DtArtPartsAdmin &orig)
	copy constructor More...
const DtArtPartsAdmin &	operator= (const DtArtPartsAdmin &orig)
	assignment operator; same as copy costructor. More...
virtual	~DtArtPartsAdmin ()
	destructor More...
virtual bool	init ()
	Call after construction. More...
virtual const DtAdminContentMessageType &	type () const
virtual void	addArtPart (int partType)
	Add an additional articulated part to the end of the list. More...
virtual void	setArtPartParam (int partType, int paramType, double current, double min, double max)
	Sets or adds an articulated parameter value. More...
virtual void	clearArtParts ()
	Clear the current art part list. More...
virtual DtAdminContent *	clone () const
	Make a copy of this content. More...
virtual DtString	stringRep () const
	Get a readable string representation of this content. More...
virtual int	netRepSize () const
virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize)
	Decodes content from buffer. More...
virtual bool	setToNet ()
	Encodes content into buffer. More...
virtual const PartParamInfo &	artParts () const
	Direct access to the list of articulated parts and parameters. More...
virtual PartParamInfo &	artParts ()
virtual const ParamInfo &	artPartParams (int partType) const
	Direct access to the list of parameters for an articulated part. More...
virtual ParamInfo &	artPartParams (int partType)
Public Member Functions inherited from DtAdminContent
virtual	~DtAdminContent ()
	destructor More...
virtual char *	netRep ()

Static Public Member Functions
static DtAdminContent *	create ()
	Creator function. Returns new instance of this class. More...
Static Public Member Functions inherited from DtAdminContent
static void	addAdminContentCreatorFcn (const DtAdminContentMessageType &contentName, DtAdminContentCreatorFcn fcn)
static void	setFactory (DtAdminContentFactory *factory)
static DtAdminContentFactory *	factory ()
static bool	isTypeRegistered (const DtAdminContentMessageType &type)

Protected Attributes
PartParamInfo	myArtPartParams
	The list of available parts and their parameters. More...
Protected Attributes inherited from DtAdminContent
char *	myNetRep

Additional Inherited Members
Protected Member Functions inherited from DtAdminContent
	DtAdminContent ()
	Constructors are protected because no one should instantiate the base class, just derived versions. More...
	DtAdminContent (const DtAdminContent &orig)
	copy constructor More...
const DtAdminContent &	operator= (const DtAdminContent &orig)
	assignment operator; same as copy costructor. More...
virtual char *	createNetworkBuffer ()
Static Protected Attributes inherited from DtAdminContent
static DtAdminContentFactory *	myFactory

Detailed Description

Admin content which contains the list of art parts, their parameters, and limits for a particular entity.

This is the response to the DtRequestArtPartsAdmin message.

Member Typedef Documentation

typedef std::map<int, CurrentMinAndMax> DtArtPartsAdmin::ParamInfo

typedef std::map<int, ParamInfo> DtArtPartsAdmin::PartParamInfo

Constructor & Destructor Documentation

DtArtPartsAdmin::DtArtPartsAdmin

(

)

default constructor

DtArtPartsAdmin::DtArtPartsAdmin

(

const DtArtPartsAdmin &

orig

)

copy constructor

virtual DtArtPartsAdmin::~DtArtPartsAdmin ( )

virtual

destructor

Member Function Documentation

const DtArtPartsAdmin& DtArtPartsAdmin::operator=

(

const DtArtPartsAdmin &

orig

)

assignment operator; same as copy costructor.

static DtAdminContent* DtArtPartsAdmin::create ( )

static

Creator function. Returns new instance of this class.

virtual bool DtArtPartsAdmin::init ( )

virtual

Call after construction.

Reimplemented from DtAdminContent.

virtual const DtAdminContentMessageType& DtArtPartsAdmin::type ( ) const

virtual

Returns

Implements DtAdminContent.

virtual const PartParamInfo& DtArtPartsAdmin::artParts ( ) const

virtual

Direct access to the list of articulated parts and parameters.

virtual PartParamInfo& DtArtPartsAdmin::artParts ( )

virtual

virtual void DtArtPartsAdmin::addArtPart ( int  partType )

virtual

Add an additional articulated part to the end of the list.

virtual const ParamInfo& DtArtPartsAdmin::artPartParams ( int  partType ) const

virtual

Direct access to the list of parameters for an articulated part.

virtual ParamInfo& DtArtPartsAdmin::artPartParams ( int  partType )

virtual

virtual void DtArtPartsAdmin::setArtPartParam ( int  partType, int  paramType, double  current, double  min, double  max  )

virtual

Sets or adds an articulated parameter value.

virtual void DtArtPartsAdmin::clearArtParts ( )

virtual

Clear the current art part list.

virtual DtAdminContent* DtArtPartsAdmin::clone ( ) const

virtual

Make a copy of this content.

Returns a pointer to a newly created copy of this class.

Implements DtAdminContent.

virtual DtString DtArtPartsAdmin::stringRep ( ) const

virtual

Get a readable string representation of this content.

Implements DtAdminContent.

virtual int DtArtPartsAdmin::netRepSize ( ) const

virtual

Returns

Size of the serialized representation of this admin content.

Reimplemented from DtAdminContent.

virtual bool DtArtPartsAdmin::setFromNet ( const char *  contentBuffer, unsigned  contentSize  )

virtual

Decodes content from buffer.

Reimplemented from DtAdminContent.

virtual bool DtArtPartsAdmin::setToNet ( )

virtual

Encodes content into buffer.

Reimplemented from DtAdminContent.

Member Data Documentation

PartParamInfo DtArtPartsAdmin::myArtPartParams

protected

The list of available parts and their parameters.

---

The documentation for this class was generated from the following file:

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-8-branch/include/vrftasks/artPartsAdmin.h