GU_AgentCustomDataItem Class Reference

#include <GU_AgentCustomDataItem.h>

Inheritance diagram for GU_AgentCustomDataItem:

Public Member Functions
virtual	~GU_AgentCustomDataItem ()=default
virtual const UT_StringHolder &	dataItemType () const =0
virtual const UT_StringHolder &	name () const =0
virtual int64	getMemoryUsage (bool inclusive) const =0
	The amount of memory used by this item. More...
virtual bool	load (UT_JSONParser &p)=0
	Load the data from JSON. More...
virtual bool	save (UT_JSONWriter &w) const =0
	Save the data to JSON. More...
Public Member Functions inherited from UT_IntrusiveRefCounter< GU_AgentCustomDataItem >
SYS_FORCE_INLINE	UT_IntrusiveRefCounter () noexcept
	Default constructor: Sets counter to 0. More...
SYS_FORCE_INLINE	UT_IntrusiveRefCounter (const UT_IntrusiveRefCounter &) noexcept
	Copy constructor: Sets counter to 0. More...
UT_IntrusiveRefCounter &	operator= (const UT_IntrusiveRefCounter &) noexcept
	Assignment operator: Does not modify counter. More...
SYS_FORCE_INLINE uint32	use_count () const noexcept
	Return current counter. More...
SYS_FORCE_INLINE bool	conditionalAddRef () noexcept

Additional Inherited Members
Protected Member Functions inherited from UT_IntrusiveRefCounter< GU_AgentCustomDataItem >
SYS_FORCE_INLINE	~UT_IntrusiveRefCounter ()
	Destructor: Only derived classes can destruct this. More...

Detailed Description

A custom data item that can be added to a GU_AgentDefinition.

Custom data item types are registered by calling GU_AgentDefinition::registerCustomDataItemType() from the GUregisterAgentCustomDataItemType() entry point.

Examples:

SOP/SOP_BouncyAgent.C.

Definition at line 29 of file GU_AgentCustomDataItem.h.

Constructor & Destructor Documentation

virtual GU_AgentCustomDataItem::~GU_AgentCustomDataItem ( )

virtualdefault

Member Function Documentation

virtual const UT_StringHolder& GU_AgentCustomDataItem::dataItemType ( ) const

pure virtual

Unique identifier for the data item type, used when serializing to a geometry file. This should correspond to the identifier passed to GU_AgentDefinition::registerCustomDataItemType().

Implemented in GU_BouncyAgentCustomData.

virtual int64 GU_AgentCustomDataItem::getMemoryUsage ( bool  inclusive ) const

pure virtual

The amount of memory used by this item.

Implemented in GU_BouncyAgentCustomData.

virtual bool GU_AgentCustomDataItem::load ( UT_JSONParser &  p )

pure virtual

Load the data from JSON.

Implemented in GU_BouncyAgentCustomData.

virtual const UT_StringHolder& GU_AgentCustomDataItem::name ( ) const

pure virtual

Name of the data item, used by GU_AgentDefinition when inserting or search for an item. This varies per instance, unlike dataItemType().

Implemented in GU_BouncyAgentCustomData.

virtual bool GU_AgentCustomDataItem::save ( UT_JSONWriter &  w ) const

pure virtual

Save the data to JSON.

Implemented in GU_BouncyAgentCustomData.

---

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

• GU/GU_AgentCustomDataItem.h