Base interface of any engine object. More...

#include <DGLE.h>

Inheritance diagram for IEngineBaseObject:

Public Member Functions
virtual DGLE_RESULT DGLE_API	Free ()=0
	Releases object and deallocates memory.

virtual DGLE_RESULT DGLE_API	GetType (E_ENGINE_OBJECT_TYPE &eObjType)=0
	Returns type of object.

virtual DGLE_RESULT DGLE_API	GetUnknownType (uint &uiObjUnknownType)=0
	In case object type is EOT_UNKNOWN, you can use this function to get specific object type id.

Public Member Functions inherited from IDGLE_Base
virtual DGLE_RESULT DGLE_API	GetGUID (GUID &guid)=0
	Returns unique identifier of the last interface in the inheritance chain.

virtual DGLE_RESULT DGLE_API	ExecuteCommand (uint uiCmd, TVariant &stVar)=0
	Executes some command using its index or bitmask.

virtual DGLE_RESULT DGLE_API	ExecuteTextCommand (const char *pcCommand, TVariant &stVar)=0
	Executes some text command and returns result as variant.

virtual DGLE_RESULT DGLE_API	ExecuteTextCommandEx (const char pcCommand, char pcResult, uint &uiCharsCount)=0
	Executes some text command and returns result as string.

Detailed Description

Base interface of any engine object.

Engine objects are commonly loaded from files by Resource Manager subsystem.

Member Function Documentation

virtual DGLE_RESULT DGLE_API Free ( )

pure virtual

Releases object and deallocates memory.

Also removes it from IResourceManager lists. After calling Free() method you can safely null the pointer to the object.

virtual DGLE_RESULT DGLE_API GetType ( E_ENGINE_OBJECT_TYPE & eObjType )

pure virtual

Returns type of object.

Parameters

[out] eObjType Type of the object to which you may cast this interface pointer.

virtual DGLE_RESULT DGLE_API GetUnknownType ( uint & uiObjUnknownType )

pure virtual

In case object type is EOT_UNKNOWN, you can use this function to get specific object type id.

Parameters

[out] uiObjUnknownType Integer with unique object type index. Meaning of these indexes must be provided by the developer of specific object type.

Returns: Returns DGLE_Types.h::S_FALSE if object is not of EOT_UNKNOWN type and DGLE_Types.h::S_OK otherwise.