ramses::DataVector2i Class Reference

The DataVector2i data object stores a vector with two 32-bit-integer components within a scene. More...

#include <DataVector2i.h>

Inheritance diagram for ramses::DataVector2i:

Collaboration diagram for ramses::DataVector2i:

Public Member Functions
status_t	setValue (int32_t x, int32_t y)
	Sets/updates the stored values of the vector. More...
status_t	getValue (int32_t &x, int32_t &y) const
	Gets all stored values of the vector. More...
Public Member Functions inherited from ramses::SceneObject
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...

Protected Member Functions
	DataVector2i (DataObjectImpl &pimpl)
	Constructor of DataVector2i. More...
virtual	~DataVector2i ()
	Destructor of the DataVector2i. More...
Protected Member Functions inherited from ramses::DataObject
	DataObject (DataObjectImpl &pimpl)
	Constructor of DataObject. More...
virtual	~DataObject ()
	Destructor for a DataObject. More...
Protected Member Functions inherited from ramses::SceneObject
	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
	Scene is the factory for creating DataVector2i instances. More...

Additional Inherited Members
Public Attributes inherited from ramses::DataObject
class DataObjectImpl &	impl
Public Attributes inherited from ramses::SceneObject
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

Detailed Description

The DataVector2i data object stores a vector with two 32-bit-integer components within a scene.

Constructor & Destructor Documentation

DataVector2i()

ramses::DataVector2i::DataVector2i ( DataObjectImpl &  pimpl )

explicitprotected

Constructor of DataVector2i.

Parameters

[in]

pimpl

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

~DataVector2i()

virtual ramses::DataVector2i::~DataVector2i ( )

protectedvirtual

Destructor of the DataVector2i.

Member Function Documentation

getValue()

status_t ramses::DataVector2i::getValue	(	int32_t &	x,
		int32_t &	y
	)		const

Gets all stored values of the vector.

Parameters

[out]	x	value of the first component of the vector.
[out]	y	value of the second component of the vector.

Returns

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

setValue()

status_t ramses::DataVector2i::setValue	(	int32_t	x,
		int32_t	y
	)

Sets/updates the stored values of the vector.

Parameters

[in]	x	new value for the first component of the vector.
[in]	y	new value for the second component of the vector.

Returns

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

Examples

ramses-example-local-scene-referencing/src/main.cpp, and ramses-example-local-viewport-link/src/main.cpp.

Friends And Related Function Documentation

SceneImpl

friend class SceneImpl

friend

Scene is the factory for creating DataVector2i instances.

---

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