anything that makes references to other objects. More...

#include <IRefObject.h>

Inheritance diagram for ParaEngine::IRefObject:

Public Member Functions
virtual const std::string &	GetIdentifier ()
	get the name or identifier. More...

virtual void	SetIdentifier (const std::string &sID)

int	GetNameW (std::u16string &out)
	gets the unicode name

const std::string &	GetName ()
	alias name for GetIdentifier

IRefObject *	GetRefObjectByName (const char *sName)

RefListItem *	GetRefObjectByTag (int nTag)
	get the first reference object by its tag

bool	HasReferences ()

RefResult	AddReference (IRefObject *maker, int nTag=0)
	add a new reference. More...

RefResult	DeleteReference (IRefObject *ref)
	delete a reference. More...

RefResult	DeleteAllRefs ()
	Deletes all references of this object. More...

int	DeleteAllRefsByTag (int nTag=0)
	Deletes all references whose tag is nTag of this object. More...

RefList &	GetRefList ()
	get the ref list

int	GetRefObjNum ()
	get the total number of references

RefListItem *	GetRefObject (int nIndex)
	get the referenced object at the given index. More...

virtual void	OnRefAdded (IRefObject *rm, int nTag=0)
	This is called after another object added this object to its reference list. More...

virtual void	OnRefDeleted (IRefObject *rm)
	This is called after another object deleted this object from its reference list. More...

Public Member Functions inherited from ParaEngine::IAttributeFields
virtual int	GetAttributeClassID ()
	attribute class ID should be identical, unless one knows how overriding rules work. More...

virtual const char *	GetAttributeClassName ()
	a static string, describing the attribute class object's name

virtual const char *	GetAttributeClassDescription ()
	a static string, describing the attribute class object

virtual int	InstallFields (CAttributeClass *pClass, bool bOverride)
	this class should be implemented if one wants to add new attribute. More...

virtual int	GetChildAttributeColumnCount ()
	we support multi-dimensional child object. More...

virtual int	GetChildAttributeObjectCount (int nColumnIndex=0)
	get the number of child objects (row count) in the given column. More...

virtual IAttributeFields *	GetChildAttributeObject (int nRowIndex, int nColumnIndex=0)

virtual IAttributeFields *	GetChildAttributeObject (const std::string &sName)
	get attribute by child object. More...

	ATTRIBUTE_METHOD1 (IAttributeFields, GetName_s, const char **)

	ATTRIBUTE_METHOD1 (IAttributeFields, SetName_s, const char *)

	ATTRIBUTE_METHOD (IAttributeFields, PrintObject_s)

	ATTRIBUTE_METHOD (IAttributeFields, AddRef_s)

	ATTRIBUTE_METHOD1 (IAttributeFields, GetRefCount_s, int *)

	ATTRIBUTE_METHOD1 (IAttributeFields, SetTime_s, int)

	ATTRIBUTE_METHOD1 (IAttributeFields, GetTime_s, int *)

	ATTRIBUTE_METHOD (IAttributeFields, Release_s)

virtual bool	IsModified ()
	whether some of the fields are modified.It is up to the implementation class to provide this functionality if necessary. More...

virtual void	SetModified (bool bModified)
	set whether any field has been modified. More...

virtual bool	ValidateFields ()
	validate all fields and return true if validation passed. More...

virtual string	GetValidationMessage ()
	get the recent validation message due to the most recent call to ValidateFields()

virtual bool	ResetField (int nFieldID)
	Reset the field to its initial or default value. More...

virtual bool	InvokeEditor (int nFieldID, const std::string &sParameters)
	Invoke an (external) editor for a given field. More...

virtual bool	AddChildAttributeObject (IAttributeFields *pChild, int nRowIndex=-1, int nColumnIndex=0)
	add child object. More...

virtual void *	QueryObjectByName (const std::string &sObjectType)
	convert to object of a given type. More...

virtual void *	QueryObject (int nObjectType)
	convert to object of a given type. More...

virtual int	GetTime ()
	get the current local time in case it is animated in milli seconds frames. More...

virtual void	SetTime (int nTime)

virtual CDynamicAttributeField *	GetDynamicField (const std::string &sName)
	Get a dynamic field with a given name. More...

virtual CDynamicAttributeField *	GetDynamicField (int nIndex)
	Get a dynamic field with a given index. More...

virtual const char *	GetDynamicFieldNameByIndex (int nIndex)
	get field name by index

virtual int	GetDynamicFieldCount ()
	how many dynamic field this object currently have. More...

virtual int	SetDynamicField (const std::string &sName, const CVariable &value)
	set a dynamic field with a given name. More...

virtual int	AddDynamicField (const std::string &sName, ATTRIBUTE_FIELDTYPE dwType)
	add dynamic field and return field index

virtual void	RemoveAllDynamicFields ()
	remove all dynamic fields

virtual int	SaveDynamicFieldsToString (std::string &output)
	save only text dynamic fields to fieldname = value text strings. More...

virtual int	LoadDynamicFieldsFromString (const std::string &input)
	load only text dynamic fields from string More...

CAttributeClass *	GetAttributeClass ()
	get the main attribute class object. More...

void	PrintObject ()
	print the content of this object to a text file at temp/doc/[ClassName].txt. More...

Public Member Functions inherited from ParaEngine::IObject
virtual void	Clone (IObject *obj) const
	Clone the object's contains to a pointer. More...

virtual IObject *	Clone () const
	Clone the object's contains and return a pointer to the newly created object. More...

virtual bool	Equals (const IObject *obj) const
	Compare the object with another object. More...

virtual const IType *	GetType () const

virtual std::string	ToString () const

WeakPtr_type &	GetWeakReference ()
	get weak reference object. More...

virtual int	ProcessObjectEvent (const ObjectEvent &event)
	this function is only used to backward compatibility of ParaObject:AddEvent() function. More...

Public Member Functions inherited from ParaEngine::CRefCounted
void	addref () const
	add reference count of the object. More...

bool	delref () const
	decrease reference count of the object. More...

int	GetRefCount () const
	get the reference count

virtual int	Release ()

CRefCounted *	AddToAutoReleasePool ()
	addref and releases the ownership sometime soon automatically (usually at the end of the current frame). More...

Protected Attributes
RefList	m_references
	This is the list of active references that refer to us.

std::string	m_sIdentifer
	unit name used in the scripting language

Protected Attributes inherited from ParaEngine::IObject
WeakPtr_type	m_weak_reference

Protected Attributes inherited from ParaEngine::CRefCounted
int	m_refcount

Additional Inherited Members
Public Types inherited from ParaEngine::IAttributeFields
typedef ParaEngine::weak_ptr< IObject, IAttributeFields >	WeakPtr_type

Public Types inherited from ParaEngine::IObject
typedef ParaEngine::weak_ptr< IObject >	WeakPtr_type

Static Public Member Functions inherited from ParaEngine::IAttributeFields
static HRESULT	GetAttributeClassID_s (IAttributeFields cls, int p1)

static HRESULT	GetAttributeClassName_s (IAttributeFields cls, const char *p1)

static bool	OpenWithDefaultEditor (const char *sFilename, bool bWaitOnReturn=false)
	Open a given file with the default registered editor in the game engine. More...

Protected Member Functions inherited from ParaEngine::IAttributeFields
virtual CAttributeClass *	CreateAttributeClass ()
	initialize fields

virtual CDynamicAttributesSet *	GetDynamicAttributes (bool bCreateIfNotExist=false)

Detailed Description

anything that makes references to other objects.

by default, it create bi-directional references. However, one can override its functions to create one-directional reference. This is unlike parent/child relationship, where reference counting is used. This is also not weak_reference, it uses event system to ensure that all referenced objects valid without the need to increase/decrease reference count.

Member Function Documentation

§ AddReference()

RefResult IRefObject::AddReference	(	IRefObject *	maker,
		int	nTag = `0`
	)

add a new reference.

Parameters

maker

Returns

§ DeleteAllRefs()

RefResult IRefObject::DeleteAllRefs ( )

Deletes all references of this object.

§ DeleteAllRefsByTag()

int IRefObject::DeleteAllRefsByTag ( int nTag = 0 )

Deletes all references whose tag is nTag of this object.

Returns: the number of object deleted.

§ DeleteReference()

RefResult IRefObject::DeleteReference ( IRefObject * ref )

delete a reference.

Parameters

ref

Returns: return REF_FAIL if reference not found. otherwise REF_SUCCEED

§ GetIdentifier()

const std::string & IRefObject::GetIdentifier ( )

virtual

get the name or identifier.

Reimplemented from ParaEngine::IAttributeFields.

§ GetRefObject()

RefListItem * IRefObject::GetRefObject ( int nIndex )

get the referenced object at the given index.

Parameters

nIndex

Returns: NULL if invalid index.

§ GetRefObjectByName()

IRefObject * IRefObject::GetRefObjectByName ( const char * sName )

Parameters

sName

Returns: NULL if not found.

§ HasReferences()

bool ParaEngine::IRefObject::HasReferences ( )

inline

Returns: return false if empty

§ OnRefAdded()

void IRefObject::OnRefAdded	(	IRefObject *	rm,
		int	nTag = `0`
	)

virtual

This is called after another object added this object to its reference list.

If this object needs to know, it can override it.

Parameters

rm
nTag	default to 0

Remarks: : one can call AddReference in the OnRefAdded, to create bi-directional reference. By default, a bi-directional reference is created in this function

§ OnRefDeleted()

void IRefObject::OnRefDeleted ( IRefObject * rm )

virtual

This is called after another object deleted this object from its reference list.

If this object needs to know, it can override it.

Parameters

rm

Remarks: : one can call DeleteReference in the OnRefDeleted, to delete bi-directional reference. By default, a bi-directional reference is deleted in this function

Reimplemented in ParaEngine::SceneState::List_PostRenderObject_TrackRef_Type, and ParaEngine::CSelectionManager.

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

Client/trunk/ParaEngineClient/3dengine/IRefObject.h
Client/trunk/ParaEngineClient/3dengine/IRefObject.cpp

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

§ AddReference()

§ DeleteAllRefs()

§ DeleteAllRefsByTag()

§ DeleteReference()

§ GetIdentifier()

§ GetRefObject()

§ GetRefObjectByName()

§ HasReferences()

§ OnRefAdded()

§ OnRefDeleted()