ramses::RamsesObject Class Reference

The RamsesObject is a base class for all client API objects owned by the framework. More...

#include <RamsesObject.h>

Inheritance diagram for ramses::RamsesObject:

Collaboration diagram for ramses::RamsesObject:

Public Member Functions
const char *	getName () const
	Returns the name of the object. More...
status_t	setName (const char *name)
	Changes the name of the object. More...
ERamsesObjectType	getType () const
	Gets type of the object. More...
bool	isOfType (ERamsesObjectType type) const
	Checks if the object is of given type. More...
Public Member Functions inherited from ramses::StatusObject
status_t	validate () const
	Generates verbose validation of the object. More...
const char *	getValidationReport (EValidationSeverity minSeverity=EValidationSeverity_Info) const
	Provides verbose report in human readable form generated by validate. More...
const char *	getStatusMessage (status_t status) const
	Get the string description for a status provided by a RAMSES API function. More...
	StatusObject (const StatusObject &other)=delete
	Deleted copy constructor. More...
StatusObject &	operator= (const StatusObject &other)=delete
	Deleted copy assignment. More...

Public Attributes
class RamsesObjectImpl &	impl
Public Attributes inherited from ramses::StatusObject
class StatusObjectImpl &	impl

Protected Member Functions
	RamsesObject (RamsesObjectImpl &pimpl)
	Constructor for RamsesObject. More...
virtual	~RamsesObject ()
	Destructor of the RamsesObject. More...
Protected Member Functions inherited from ramses::StatusObject
	StatusObject (StatusObjectImpl &pimpl)
	Constructor for StatusObject. More...
virtual	~StatusObject ()
	Destructor of the StatusObject. More...

Detailed Description

The RamsesObject is a base class for all client API objects owned by the framework.

Examples

ramses-example-basic-file-loading/src/main.cpp.

Constructor & Destructor Documentation

RamsesObject()

ramses::RamsesObject::RamsesObject ( RamsesObjectImpl &  pimpl )

explicitprotected

Constructor for RamsesObject.

Parameters

[in]

pimpl

Internal data for implementation specifics of RamsesObject (sink - instance becomes owner)

~RamsesObject()

virtual ramses::RamsesObject::~RamsesObject ( )

protectedvirtual

Destructor of the RamsesObject.

Member Function Documentation

getName()

const char* ramses::RamsesObject::getName

(

)

const

Returns the name of the object.

Returns

Name of the object

Examples

ramses-example-basic-scenegraph/src/main.cpp.

getType()

ERamsesObjectType ramses::RamsesObject::getType

(

)

const

Gets type of the object.

Returns

Type of the object, see ERamsesObjectType enum for possible values.

isOfType()

bool ramses::RamsesObject::isOfType

(

ERamsesObjectType

type

)

const

Checks if the object is of given type.

Parameters

[in]

type

Type to check against.

Returns

True if object is of given type, ie. it can be converted to given type.

setName()

status_t ramses::RamsesObject::setName

(

const char *

name

)

Changes the name of the object.

Parameters

name	New name of the object

Returns

StatusOK for success, otherwise the returned status can be used to resolve error message using getStatusMessage().

Member Data Documentation

impl

class RamsesObjectImpl& ramses::RamsesObject::impl

Stores internal data for implementation specifics of RamsesObject.

---

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

• /home/runner/work/ramses/ramses/client/ramses-client/ramses-client-api/include/ramses-client-api/RamsesObject.h