VTK  9.4.20241118
Public Member Functions | List of all members
RTW::Object Class Referenceabstract

#include <Object.h>

Inheritance diagram for RTW::Object:
[legend]

Public Member Functions

 Object (RTWDataType type=RTW_OBJECT)
 
virtual ~Object ()
 
virtual void Commit ()=0
 
void AddRef ()
 
void Release ()
 
void SetString (const std::string &id, const std::string &s)
 
const std::string GetString (const std::vector< std::string > &ids, const std::string &defaultValue="", bool *found=nullptr) const
 
bool GetString (const std::vector< std::string > &ids, std::string *result, const std::string &defaultValue=nullptr)
 
void SetBool (const std::string &id, bool b)
 
virtual void SetObject (const std::string &id, Object *object)
 
template<typename T = Object>
T * GetObject (const std::vector< std::string > &ids, T *defaultValue=nullptr, bool *found=nullptr) const
 
template<typename T = Object>
bool GetObject (const std::vector< std::string > &ids, T **result, T *defaultValue=nullptr)
 
void SetInt (const std::string &id, int32_t x)
 
int32_t GetInt (const std::vector< std::string > &ids, int32_t defaultValue=0, bool *found=nullptr) const
 
bool GetInt (const std::vector< std::string > &ids, int32_t *result, int32_t defaultValue=0)
 
void SetFloat (const std::string &id, float x)
 
float GetFloat (const std::vector< std::string > &ids, float defaultValue=0.0f, bool *found=nullptr) const
 
bool GetFloat (const std::vector< std::string > &ids, float *result, float defaultValue=0.0f)
 
void SetVec2i (const std::string &id, int32_t x, int32_t y)
 
VisRTX::Vec2i GetVec2i (const std::vector< std::string > &ids, const VisRTX::Vec2i &defaultValue=VisRTX::Vec2i(), bool *found=nullptr) const
 
bool GetVec2i (const std::vector< std::string > &ids, VisRTX::Vec2i *result, const VisRTX::Vec2i &defaultValue=VisRTX::Vec2i())
 
void SetVec2f (const std::string &id, float x, float y)
 
VisRTX::Vec2f GetVec2f (const std::vector< std::string > &ids, const VisRTX::Vec2f &defaultValue=VisRTX::Vec2f(), bool *found=nullptr) const
 
bool GetVec2f (const std::vector< std::string > &ids, VisRTX::Vec2f *result, const VisRTX::Vec2f &defaultValue=VisRTX::Vec2f())
 
void SetVec3i (const std::string &id, int32_t x, int32_t y, int32_t z)
 
VisRTX::Vec3i GetVec3i (const std::vector< std::string > &ids, const VisRTX::Vec3i &defaultValue=VisRTX::Vec3i(), bool *found=nullptr) const
 
bool GetVec3i (const std::vector< std::string > &ids, VisRTX::Vec3i *result, const VisRTX::Vec3i &defaultValue=VisRTX::Vec3i())
 
void SetVec3f (const std::string &id, float x, float y, float z)
 
VisRTX::Vec3f GetVec3f (const std::vector< std::string > &ids, const VisRTX::Vec3f &defaultValue=VisRTX::Vec3f(), bool *found=nullptr) const
 
bool GetVec3f (const std::vector< std::string > &ids, VisRTX::Vec3f *result, const VisRTX::Vec3f &defaultValue=VisRTX::Vec3f())
 
void SetVec4f (const std::string &id, float x, float y, float z, float w)
 
VisRTX::Vec4f GetVec4f (const std::vector< std::string > &ids, const VisRTX::Vec4f &defaultValue=VisRTX::Vec4f(), bool *found=nullptr) const
 
bool GetVec4f (const std::vector< std::string > &ids, VisRTX::Vec4f *result, const VisRTX::Vec4f &defaultValue=VisRTX::Vec4f())
 
virtual void RemoveParam (const std::string &id)
 
void PrintAllParameters () const
 
std::set< std::string > GetAllParameters () const
 
RTWDataType GetDataType () const
 

Detailed Description

Definition at line 21 of file Object.h.

Constructor & Destructor Documentation

◆ Object()

RTW::Object::Object ( RTWDataType  type = RTW_OBJECT)
inline

Definition at line 24 of file Object.h.

◆ ~Object()

virtual RTW::Object::~Object ( )
inlinevirtual

Definition at line 30 of file Object.h.

Member Function Documentation

◆ Commit()

virtual void RTW::Object::Commit ( )
pure virtual

◆ AddRef()

void RTW::Object::AddRef ( )
inline

Definition at line 41 of file Object.h.

◆ Release()

void RTW::Object::Release ( )
inline

Definition at line 46 of file Object.h.

◆ SetString()

void RTW::Object::SetString ( const std::string &  id,
const std::string &  s 
)
inline

Definition at line 59 of file Object.h.

◆ GetString() [1/2]

const std::string RTW::Object::GetString ( const std::vector< std::string > &  ids,
const std::string &  defaultValue = "",
bool *  found = nullptr 
) const
inline

Definition at line 64 of file Object.h.

◆ GetString() [2/2]

bool RTW::Object::GetString ( const std::vector< std::string > &  ids,
std::string *  result,
const std::string &  defaultValue = nullptr 
)
inline

Definition at line 69 of file Object.h.

◆ SetBool()

void RTW::Object::SetBool ( const std::string &  id,
bool  b 
)
inline

Definition at line 76 of file Object.h.

◆ SetObject()

virtual void RTW::Object::SetObject ( const std::string &  id,
Object object 
)
inlinevirtual

Reimplemented in RTW::Group, and RTW::World.

Definition at line 81 of file Object.h.

◆ GetObject() [1/2]

template<typename T = Object>
T * RTW::Object::GetObject ( const std::vector< std::string > &  ids,
T *  defaultValue = nullptr,
bool *  found = nullptr 
) const
inline

Definition at line 101 of file Object.h.

◆ GetObject() [2/2]

template<typename T = Object>
bool RTW::Object::GetObject ( const std::vector< std::string > &  ids,
T **  result,
T *  defaultValue = nullptr 
)
inline

Definition at line 107 of file Object.h.

◆ SetInt()

void RTW::Object::SetInt ( const std::string &  id,
int32_t  x 
)
inline

Definition at line 114 of file Object.h.

◆ GetInt() [1/2]

int32_t RTW::Object::GetInt ( const std::vector< std::string > &  ids,
int32_t  defaultValue = 0,
bool *  found = nullptr 
) const
inline

Definition at line 119 of file Object.h.

◆ GetInt() [2/2]

bool RTW::Object::GetInt ( const std::vector< std::string > &  ids,
int32_t *  result,
int32_t  defaultValue = 0 
)
inline

Definition at line 124 of file Object.h.

◆ SetFloat()

void RTW::Object::SetFloat ( const std::string &  id,
float  x 
)
inline

Definition at line 131 of file Object.h.

◆ GetFloat() [1/2]

float RTW::Object::GetFloat ( const std::vector< std::string > &  ids,
float  defaultValue = 0.0f,
bool *  found = nullptr 
) const
inline

Definition at line 136 of file Object.h.

◆ GetFloat() [2/2]

bool RTW::Object::GetFloat ( const std::vector< std::string > &  ids,
float *  result,
float  defaultValue = 0.0f 
)
inline

Definition at line 141 of file Object.h.

◆ SetVec2i()

void RTW::Object::SetVec2i ( const std::string &  id,
int32_t  x,
int32_t  y 
)
inline

Definition at line 148 of file Object.h.

◆ GetVec2i() [1/2]

VisRTX::Vec2i RTW::Object::GetVec2i ( const std::vector< std::string > &  ids,
const VisRTX::Vec2i &  defaultValue = VisRTX::Vec2i(),
bool *  found = nullptr 
) const
inline

Definition at line 153 of file Object.h.

◆ GetVec2i() [2/2]

bool RTW::Object::GetVec2i ( const std::vector< std::string > &  ids,
VisRTX::Vec2i *  result,
const VisRTX::Vec2i &  defaultValue = VisRTX::Vec2i() 
)
inline

Definition at line 158 of file Object.h.

◆ SetVec2f()

void RTW::Object::SetVec2f ( const std::string &  id,
float  x,
float  y 
)
inline

Definition at line 165 of file Object.h.

◆ GetVec2f() [1/2]

VisRTX::Vec2f RTW::Object::GetVec2f ( const std::vector< std::string > &  ids,
const VisRTX::Vec2f &  defaultValue = VisRTX::Vec2f(),
bool *  found = nullptr 
) const
inline

Definition at line 170 of file Object.h.

◆ GetVec2f() [2/2]

bool RTW::Object::GetVec2f ( const std::vector< std::string > &  ids,
VisRTX::Vec2f *  result,
const VisRTX::Vec2f &  defaultValue = VisRTX::Vec2f() 
)
inline

Definition at line 175 of file Object.h.

◆ SetVec3i()

void RTW::Object::SetVec3i ( const std::string &  id,
int32_t  x,
int32_t  y,
int32_t  z 
)
inline

Definition at line 182 of file Object.h.

◆ GetVec3i() [1/2]

VisRTX::Vec3i RTW::Object::GetVec3i ( const std::vector< std::string > &  ids,
const VisRTX::Vec3i &  defaultValue = VisRTX::Vec3i(),
bool *  found = nullptr 
) const
inline

Definition at line 187 of file Object.h.

◆ GetVec3i() [2/2]

bool RTW::Object::GetVec3i ( const std::vector< std::string > &  ids,
VisRTX::Vec3i *  result,
const VisRTX::Vec3i &  defaultValue = VisRTX::Vec3i() 
)
inline

Definition at line 192 of file Object.h.

◆ SetVec3f()

void RTW::Object::SetVec3f ( const std::string &  id,
float  x,
float  y,
float  z 
)
inline

Definition at line 199 of file Object.h.

◆ GetVec3f() [1/2]

VisRTX::Vec3f RTW::Object::GetVec3f ( const std::vector< std::string > &  ids,
const VisRTX::Vec3f &  defaultValue = VisRTX::Vec3f(),
bool *  found = nullptr 
) const
inline

Definition at line 204 of file Object.h.

◆ GetVec3f() [2/2]

bool RTW::Object::GetVec3f ( const std::vector< std::string > &  ids,
VisRTX::Vec3f *  result,
const VisRTX::Vec3f &  defaultValue = VisRTX::Vec3f() 
)
inline

Definition at line 209 of file Object.h.

◆ SetVec4f()

void RTW::Object::SetVec4f ( const std::string &  id,
float  x,
float  y,
float  z,
float  w 
)
inline

Definition at line 216 of file Object.h.

◆ GetVec4f() [1/2]

VisRTX::Vec4f RTW::Object::GetVec4f ( const std::vector< std::string > &  ids,
const VisRTX::Vec4f &  defaultValue = VisRTX::Vec4f(),
bool *  found = nullptr 
) const
inline

Definition at line 221 of file Object.h.

◆ GetVec4f() [2/2]

bool RTW::Object::GetVec4f ( const std::vector< std::string > &  ids,
VisRTX::Vec4f *  result,
const VisRTX::Vec4f &  defaultValue = VisRTX::Vec4f() 
)
inline

Definition at line 226 of file Object.h.

◆ RemoveParam()

virtual void RTW::Object::RemoveParam ( const std::string &  id)
inlinevirtual

Reimplemented in RTW::Group, and RTW::World.

Definition at line 233 of file Object.h.

◆ PrintAllParameters()

void RTW::Object::PrintAllParameters ( ) const
inline

Definition at line 247 of file Object.h.

◆ GetAllParameters()

std::set< std::string > RTW::Object::GetAllParameters ( ) const
inline

Definition at line 277 of file Object.h.

◆ GetDataType()

RTWDataType RTW::Object::GetDataType ( ) const
inline

Definition at line 309 of file Object.h.


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