VR-Forces 5.0.2 Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Protected Member Functions | Protected Attributes | Friends
makArchives::DtPropRecord Class Reference

A DtPropRecord contains the information to recreate a prop.

Public Member Functions

 DtPropRecord ()
 
 ~DtPropRecord ()
 
 DtPropRecord (const DtPropRecord &orig)
 
bool operator== (const DtPropRecord &orig) const
 
bool operator!= (const DtPropRecord &orig) const
 
DtPropRecordoperator= (const DtPropRecord &orig)
 
void setName (const std::string &name)
 
const std::string & name () const
 
void setPosition (double x, double y, double z)
 
void getPosition (double &xOut, double &yOut, double &zOut) const
 
void setOrientation (double x, double y, double z, double w)
 
void getOrientation (double &xOut, double &yOut, double &zOut, double &wOut) const
 
void setPropType (const std::string &propType)
 
const std::string & propType () const
 
void setModelDefOrNodeAddress (const std::string &modelDefOrNodeAddress)
 
const std::string & modelDefOrNodeAddress () const
 
void setIsModelDef (bool bIsModelDef)
 
bool isModelDef () const
 
void setColor (float r, float g, float b, float alpha)
 
void getColor (float &r, float &g, float &b, float &alpha) const
 
void setIsVisible (bool flag)
 
bool isVisible () const
 

Protected Member Functions

template<class Archive >
void serialize (Archive &ar, const unsigned int version)
 

Protected Attributes

std::string myName
 
double myPosX
 
double myPosY
 
double myPosZ
 
double myOrientationX
 
double myOrientationY
 
double myOrientationZ
 
double myOrientationW
 
std::string myPropType
 
std::string myModelDefOrNodeAddress
 
bool myIsModelDefFlag
 
float myColorR
 
float myColorG
 
float myColorB
 
float myColorA
 
bool myIsVisible
 

Friends

class boost::serialization::access
 

Constructor & Destructor Documentation

makArchives::DtPropRecord::DtPropRecord ( )

CTOR.

makArchives::DtPropRecord::~DtPropRecord ( )

DTOR.

makArchives::DtPropRecord::DtPropRecord ( const DtPropRecord orig)

Copy CTOR.

Member Function Documentation

bool makArchives::DtPropRecord::operator== ( const DtPropRecord orig) const
bool makArchives::DtPropRecord::operator!= ( const DtPropRecord orig) const
DtPropRecord& makArchives::DtPropRecord::operator= ( const DtPropRecord orig)

Assignment OP.

void makArchives::DtPropRecord::setName ( const std::string &  name)

Set the name of the prop.

const std::string& makArchives::DtPropRecord::name ( ) const

Get the name of the prop.

void makArchives::DtPropRecord::setPosition ( double  x,
double  y,
double  z 
)

Set position.

void makArchives::DtPropRecord::getPosition ( double xOut,
double yOut,
double zOut 
) const

Get position.

void makArchives::DtPropRecord::setOrientation ( double  x,
double  y,
double  z,
double  w 
)

Set orientation (as quaternion).

void makArchives::DtPropRecord::getOrientation ( double xOut,
double yOut,
double zOut,
double wOut 
) const

Get orientation (as quaternion).

void makArchives::DtPropRecord::setPropType ( const std::string &  propType)

Set the prop type of this record.

const std::string& makArchives::DtPropRecord::propType ( ) const

Return the prop type of this record.

void makArchives::DtPropRecord::setModelDefOrNodeAddress ( const std::string &  modelDefOrNodeAddress)

Set the model definition or node address of this record.

const std::string& makArchives::DtPropRecord::modelDefOrNodeAddress ( ) const

Return the model definition or node address of this record.

void makArchives::DtPropRecord::setIsModelDef ( bool  bIsModelDef)

Set whether modelDefOrNodeAddress() returns a model definition or node address. True is model def, false is node address.

bool makArchives::DtPropRecord::isModelDef ( ) const

Return whether modelDefOrNodeAddress() returns a model definition or node address. True is model def, false is node address.

void makArchives::DtPropRecord::setColor ( float  r,
float  g,
float  b,
float  alpha 
)

Set color.

void makArchives::DtPropRecord::getColor ( float &  r,
float &  g,
float &  b,
float &  alpha 
) const

Get color.

void makArchives::DtPropRecord::setIsVisible ( bool  flag)

Set isVisible.

bool makArchives::DtPropRecord::isVisible ( ) const

Get isVisible.

template<class Archive >
void makArchives::DtPropRecord::serialize ( Archive &  ar,
const unsigned int  version 
)
inlineprotected

When the class Archive corresponds to an output archive, the & operator is defined similar to <<. Likewise, when the class Archive is a type of input archive the & operator is defined similar to >>.

Friends And Related Function Documentation

friend class boost::serialization::access
friend

Serialization/Deserialization //.

Member Data Documentation

std::string makArchives::DtPropRecord::myName
protected
double makArchives::DtPropRecord::myPosX
protected
double makArchives::DtPropRecord::myPosY
protected
double makArchives::DtPropRecord::myPosZ
protected
double makArchives::DtPropRecord::myOrientationX
protected
double makArchives::DtPropRecord::myOrientationY
protected
double makArchives::DtPropRecord::myOrientationZ
protected
double makArchives::DtPropRecord::myOrientationW
protected
std::string makArchives::DtPropRecord::myPropType
protected
std::string makArchives::DtPropRecord::myModelDefOrNodeAddress
protected
bool makArchives::DtPropRecord::myIsModelDefFlag
protected
float makArchives::DtPropRecord::myColorR
protected
float makArchives::DtPropRecord::myColorG
protected
float makArchives::DtPropRecord::myColorB
protected
float makArchives::DtPropRecord::myColorA
protected
bool makArchives::DtPropRecord::myIsVisible
protected

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

Document ID: Generated on Sun Dec 4 20:22:03 EST 2022 from SVN revision 249613
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)