RTFX  0.3
Real time special effects collaborative visualization and production library.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends
Public Member Functions | Private Member Functions | Private Attributes | Friends | List of all members
RTFX::RTFXPropertyRawData Class Reference

Properties which are raw dat. More...

#include <RTFXPropertyRawData.h>

Inheritance diagram for RTFX::RTFXPropertyRawData:
RTFX::RTFXProperty

Public Member Functions

 RTFXPropertyRawData ()
 
void Copy (RTFXProperty *_p)
 
 ~RTFXPropertyRawData ()
 
void SetValue (char *_value, RTFXBIGINT _length)
 
char * GetValue ()
 
RTFXBIGINT GetLength ()
 
void SetValue (std::string _path, std::string _fileName, std::string _fileType)
 
void WriteFile (std::string _location)
 
void SetFileName (std::string _fileName)
 
void SetFileType (std::string _fileType)
 
std::string GetFileName ()
 
std::string GetFileType ()
 
bool EqualTo (RTFXProperty *_other)
 
- Public Member Functions inherited from RTFX::RTFXProperty
 RTFXProperty ()
 
virtual ~RTFXProperty ()
 
void SetType (RTFXPropertyType _type)
 
void SetName (string _name)
 
void SetOwner (boost::uuids::uuid _owner)
 
void SetChanged (bool _changed)
 
void SetDescription (string _description)
 
void SetID (unsigned int _id)
 
void SetDelete (bool _v)
 
bool GetDelete ()
 
void SetAll (string _name, string _description, bool _changed, unsigned int _id)
 
RTFXPropertyType GetType ()
 
string GetName ()
 
boost::uuids::uuid GetOwner ()
 
bool GetChanged ()
 
string GetDescription ()
 
unsigned int GetID ()
 
virtual void ChangeFrame (AXISFRAME frameA, AXISFRAME frameB)
 
void SetBasis (bool _basis)
 
bool GetBasis ()
 
void SetOwnedByObject (bool _ownedByObject)
 
bool GetOwnedByObject ()
 
RTFXPropertyData GetDataType ()
 
void SetDataType (RTFXPropertyData _dt)
 
AXISFRAME GetAxis ()
 
void SetAxis (AXISFRAME _frame)
 

Private Member Functions

template<class Archive >
void save (Archive &_ar, const unsigned int _version) const
 
template<class Archive >
void load (Archive &_ar, const unsigned int _version)
 
template<class Archive >
void serialize (Archive &_ar, const unsigned int _version)
 

Private Attributes

char * value
 
RTFXBIGINT length
 
std::string fileName
 
std::string fileType
 

Friends

class boost::serialization::access
 Serialization Routines.
 

Additional Inherited Members

- Public Types inherited from RTFX::RTFXProperty
enum  RTFXPropertyType {
  BASICTYPE = 0, STRING = 1, CHARARRAY = 2, VECTOR3 = 3,
  POINT3 = 4, MATRIX4 = 5, RAWDATA = 6, VECTOROF = 7,
  COLOUR = 8, BASICARRAY = 9, DELETEOBJECT = 10
}
 
enum  RTFXPropertyData {
  CHAR = 0, BOOL = 1, INT = 2, UNSIGNEDINT = 3,
  DOUBLE = 4, FLOAT = 5, DATASTRING = 6, UNKNOWN = 7
}
 
- Static Public Member Functions inherited from RTFX::RTFXProperty
static void EncodeLong (RTFXBIGINT _encodeMe, char *_data)
 
static void DecodeLong (RTFXBIGINT &_decodeTo, char *_data)
 
- Protected Attributes inherited from RTFX::RTFXProperty
boost::mutex * dataLock
 

Detailed Description

Properties which are raw dat.

This property type is not templated, and can only represent an array of raw data. This property is meant to hold unprocessed (hence, raw) files, such as images, FBX, OTL, audio, etc.

Constructor & Destructor Documentation

RTFX::RTFXPropertyRawData::RTFXPropertyRawData ( )
inline

Constructor: initializes the TYPE to RAWDATA, and the value to null

RTFX::RTFXPropertyRawData::~RTFXPropertyRawData ( )
inline

Destructor

Member Function Documentation

void RTFX::RTFXPropertyRawData::Copy ( RTFXProperty *  _p)
inlinevirtual

Turn this object into a copy of another

Implements RTFX::RTFXProperty.

References RTFX::RTFXProperty::GetChanged(), RTFX::RTFXProperty::GetDelete(), RTFX::RTFXProperty::GetDescription(), RTFX::RTFXProperty::GetID(), RTFX::RTFXProperty::GetName(), RTFX::RTFXProperty::GetOwner(), and RTFX::RTFXProperty::GetType().

bool RTFX::RTFXPropertyRawData::EqualTo ( RTFXProperty *  _other)
inlinevirtual

Determine if this property is equal to another: assumes the properties are of the same type and template

Implements RTFX::RTFXProperty.

References RTFX::RTFXProperty::GetType().

std::string RTFX::RTFXPropertyRawData::GetFileName ( )
inline

Get the file name of the property

std::string RTFX::RTFXPropertyRawData::GetFileType ( )
inline

Get the file type of the property

RTFXBIGINT RTFX::RTFXPropertyRawData::GetLength ( )
inlinevirtual

Get the length of the character array

Reimplemented from RTFX::RTFXProperty.

char* RTFX::RTFXPropertyRawData::GetValue ( )
inline

Get the value of this property

void RTFX::RTFXPropertyRawData::SetFileName ( std::string  _fileName)
inline

Set the file name of the property

void RTFX::RTFXPropertyRawData::SetFileType ( std::string  _fileType)
inline

Set the file type of the property

void RTFX::RTFXPropertyRawData::SetValue ( char *  _value,
RTFXBIGINT  _length 
)
inline

Set the value of this property

void RTFX::RTFXPropertyRawData::SetValue ( std::string  _path,
std::string  _fileName,
std::string  _fileType 
)
inline

Set the value of this property by loading data directly from the file

void RTFX::RTFXPropertyRawData::WriteFile ( std::string  _location)
inline

Write the contents of this property to a file on the local disk

Member Data Documentation

std::string RTFX::RTFXPropertyRawData::fileName
private

The name of the file which this property contains

std::string RTFX::RTFXPropertyRawData::fileType
private

The type of the file which this property contains

RTFXBIGINT RTFX::RTFXPropertyRawData::length
private

The length of the array storing the binary data

char* RTFX::RTFXPropertyRawData::value
private

The value of this property

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