The SceneObject is a base class for all client API objects owned by a Scene. More...

#include <SceneObject.h>

Inheritance diagram for ramses::SceneObject:

Collaboration diagram for ramses::SceneObject:

Public Member Functions
sceneObjectId_t	getSceneObjectId () const
	Returns scene object id which is automatically assigned at creation time of object and is unique within scope of one scene. More...

sceneId_t	getSceneId () const
	Returns sceneid to which this object belongs to. More...

Public Member Functions inherited from ramses::RamsesObject
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 SceneObjectImpl &	impl

Public Attributes inherited from ramses::ClientObject
class ClientObjectImpl &	impl

Public Attributes inherited from ramses::RamsesObject
class RamsesObjectImpl &	impl

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

Protected Member Functions
	SceneObject (SceneObjectImpl &pimpl)
	Constructor for SceneObject. More...

virtual	~SceneObject ()
	Destructor of the SceneObject. More...

Protected Member Functions inherited from ramses::ClientObject
	ClientObject (ClientObjectImpl &pimpl)
	Constructor for ClientObject. More...

virtual	~ClientObject ()
	Destructor of the ClientObject. More...

Protected Member Functions inherited from ramses::RamsesObject
	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...

Friends
class	SceneImpl

Detailed Description

The SceneObject is a base class for all client API objects owned by a Scene.

Constructor & Destructor Documentation

◆ SceneObject()

ramses::SceneObject::SceneObject ( SceneObjectImpl & pimpl )

explicitprotected

Constructor for SceneObject.

Parameters

[in] pimpl Internal data for implementation specifics of SceneObject (sink - instance becomes owner)

◆ ~SceneObject()

virtual ramses::SceneObject::~SceneObject ( )

protectedvirtual

Destructor of the SceneObject.

Member Function Documentation

◆ getSceneId()

sceneId_t ramses::SceneObject::getSceneId ( ) const

Returns sceneid to which this object belongs to.

Returns: Scene id this object belongs to

◆ getSceneObjectId()

sceneObjectId_t ramses::SceneObject::getSceneObjectId ( ) const

Returns scene object id which is automatically assigned at creation time of object and is unique within scope of one scene.

Returns: Scene object id.

Friends And Related Function Documentation

◆ SceneImpl

friend class SceneImpl

friend

SceneImpl is the factory for creating object instances which derive from SceneObject.

Member Data Documentation

◆ impl

class SceneObjectImpl& ramses::SceneObject::impl

Stores internal data for implementation specifics of SceneObject.

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/SceneObject.h

Public Member Functions

Public Attributes

Protected Member Functions

Friends