VTK  9.4.20241118
Public Member Functions | Static Public Member Functions | List of all members
RTW::Data Class Reference

#include <Data.h>

Inheritance diagram for RTW::Data:
[legend]
Collaboration diagram for RTW::Data:
[legend]

Public Member Functions

 Data (const void *source, RTWDataType type, size_t width, bool shared=false)
 
 Data (const void *source, RTWDataType type, size_t width, size_t height, bool shared=false)
 
 Data (const void *source, RTWDataType type, size_t width, size_t height, size_t depth, bool shared=false)
 
 ~Data ()
 
void Commit () override
 
size_t GetNumElements () const
 
size_t GetWidth () const
 
size_t GetHeight () const
 
size_t GetDepth () const
 
RTWDataType GetElementDataType () const
 
size_t GetElementSize () const
 
void * GetData () const
 
bool IsShared () const
 
bool CheckDirty ()
 
- Public Member Functions inherited from RTW::Object
 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
 

Static Public Member Functions

static size_t GetElementSize (RTWDataType type)
 

Detailed Description

Definition at line 12 of file Data.h.

Constructor & Destructor Documentation

◆ Data() [1/3]

RTW::Data::Data ( const void *  source,
RTWDataType  type,
size_t  width,
bool  shared = false 
)
inline

Definition at line 55 of file Data.h.

◆ Data() [2/3]

RTW::Data::Data ( const void *  source,
RTWDataType  type,
size_t  width,
size_t  height,
bool  shared = false 
)
inline

Definition at line 58 of file Data.h.

◆ Data() [3/3]

RTW::Data::Data ( const void *  source,
RTWDataType  type,
size_t  width,
size_t  height,
size_t  depth,
bool  shared = false 
)
inline

Definition at line 61 of file Data.h.

◆ ~Data()

RTW::Data::~Data ( )
inline

Definition at line 96 of file Data.h.

Member Function Documentation

◆ GetElementSize() [1/2]

static size_t RTW::Data::GetElementSize ( RTWDataType  type)
inlinestatic

Definition at line 15 of file Data.h.

◆ Commit()

void RTW::Data::Commit ( )
inlineoverridevirtual

Implements RTW::Object.

Definition at line 113 of file Data.h.

◆ GetNumElements()

size_t RTW::Data::GetNumElements ( ) const
inline

Definition at line 119 of file Data.h.

◆ GetWidth()

size_t RTW::Data::GetWidth ( ) const
inline

Definition at line 124 of file Data.h.

◆ GetHeight()

size_t RTW::Data::GetHeight ( ) const
inline

Definition at line 129 of file Data.h.

◆ GetDepth()

size_t RTW::Data::GetDepth ( ) const
inline

Definition at line 134 of file Data.h.

◆ GetElementDataType()

RTWDataType RTW::Data::GetElementDataType ( ) const
inline

Definition at line 139 of file Data.h.

◆ GetElementSize() [2/2]

size_t RTW::Data::GetElementSize ( ) const
inline

Definition at line 144 of file Data.h.

◆ GetData()

void * RTW::Data::GetData ( ) const
inline

Definition at line 149 of file Data.h.

◆ IsShared()

bool RTW::Data::IsShared ( ) const
inline

Definition at line 154 of file Data.h.

◆ CheckDirty()

bool RTW::Data::CheckDirty ( )
inline

Definition at line 159 of file Data.h.


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