MAK Data Logger API Documentation for DIS
List of all members | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Friends
MAKLogger::DtLgrArtPart Class Reference

Instances of "DtLgrArtPart" are used by DtLgrArtPartList to handle individual articulated parts (i.e. More...

+ Collaboration diagram for MAKLogger::DtLgrArtPart:

Public Member Functions

virtual bool setUsingParam (int paramType, bool yesNo=true)
 Set/Get the "usage" state for the specified parameter type.
virtual bool usingParam (int paramType) const
virtual bool setParamValue (int paramType, float value)
 Set/Get the value for the specified parameter type.
virtual bool paramValue (int paramType, float &value) const
virtual int numParams () const
 Get the number of parameters.
void setPartType (int val)
 Set/Get the part type.
int partType () const
void setPartNum (int val)
 Set/Get the part number.
int partNum () const
void setPartAttachedTo (int val)
 Set/Get the part this part is attached to.
int partAttachedTo () const
virtual int firstValidParamType () const
 Get the first valid (added) parameter type.
virtual int nextValidParamType (int paramType) const
 Get the next valid parameter type.
virtual void print ()
 Print the part data.
virtual void print (DtString &str)

Static Public Member Functions

static bool artParamIsRate (int paramType)
 Check if a given parameter type is describes a "rate".
static int computePartType (int partPlusParam)
 Extract the part type from the (composite) part-and-parameter value.
static int computeParameterType (int partPlusParam)
 Extract the parameter type from the (composite) part-and-parameter value.

Protected Member Functions

 DtLgrArtPart ()
 Destructor, constructors, and assignment operator are protected since this class is managed by DtLgrArtPartList.
virtual ~DtLgrArtPart ()
 Destructor.
 DtLgrArtPart (const DtArtPartSpec &spec)
 Constructor (from DtArtPartSpec)
 DtLgrArtPart (const DtLgrArtPart &src)
 Copy constructor.
DtLgrArtPartoperator= (const DtLgrArtPart &src)
 Assignment operator.

Protected Attributes

float myParamVals [DtMAX_PARAMS_PER_PART+1]
unsigned int myParamSetMask
int myPartType
int myPartNum
int myPartAttachedTo

Friends

class DtLgrArtPartList

Detailed Description

Instances of "DtLgrArtPart" are used by DtLgrArtPartList to handle individual articulated parts (i.e.

this is a helper class to DtLgrArtPartList). Each instance of "DtLgrArtPart" describes one Articulated Part.

Constructor & Destructor Documentation

MAKLogger::DtLgrArtPart::DtLgrArtPart ( )
protected

Destructor, constructors, and assignment operator are protected since this class is managed by DtLgrArtPartList.

Default constructor

virtual MAKLogger::DtLgrArtPart::~DtLgrArtPart ( )
protectedvirtual

Destructor.

MAKLogger::DtLgrArtPart::DtLgrArtPart ( const DtArtPartSpec &  spec)
protected

Constructor (from DtArtPartSpec)

MAKLogger::DtLgrArtPart::DtLgrArtPart ( const DtLgrArtPart src)
protected

Copy constructor.

Member Function Documentation

static bool MAKLogger::DtLgrArtPart::artParamIsRate ( int  paramType)
static

Check if a given parameter type is describes a "rate".

static int MAKLogger::DtLgrArtPart::computeParameterType ( int  partPlusParam)
static

Extract the parameter type from the (composite) part-and-parameter value.

static int MAKLogger::DtLgrArtPart::computePartType ( int  partPlusParam)
static

Extract the part type from the (composite) part-and-parameter value.

virtual int MAKLogger::DtLgrArtPart::firstValidParamType ( ) const
virtual

Get the first valid (added) parameter type.

virtual int MAKLogger::DtLgrArtPart::nextValidParamType ( int  paramType) const
virtual

Get the next valid parameter type.

virtual int MAKLogger::DtLgrArtPart::numParams ( ) const
virtual

Get the number of parameters.

DtLgrArtPart& MAKLogger::DtLgrArtPart::operator= ( const DtLgrArtPart src)
protected

Assignment operator.

virtual bool MAKLogger::DtLgrArtPart::paramValue ( int  paramType,
float &  value 
) const
virtual
int MAKLogger::DtLgrArtPart::partAttachedTo ( ) const
inline

References myPartAttachedTo.

int MAKLogger::DtLgrArtPart::partNum ( ) const
inline

References myPartNum.

int MAKLogger::DtLgrArtPart::partType ( ) const
inline

References myPartType.

virtual void MAKLogger::DtLgrArtPart::print ( )
virtual

Print the part data.

virtual void MAKLogger::DtLgrArtPart::print ( DtString &  str)
virtual
virtual bool MAKLogger::DtLgrArtPart::setParamValue ( int  paramType,
float  value 
)
virtual

Set/Get the value for the specified parameter type.

Note: "paramValue" returns "false" if the parameter type is not being used by the articulated part (described by this instance).

void MAKLogger::DtLgrArtPart::setPartAttachedTo ( int  val)
inline

Set/Get the part this part is attached to.

References myPartAttachedTo.

void MAKLogger::DtLgrArtPart::setPartNum ( int  val)
inline

Set/Get the part number.

References myPartNum.

void MAKLogger::DtLgrArtPart::setPartType ( int  val)
inline

Set/Get the part type.

References myPartType.

virtual bool MAKLogger::DtLgrArtPart::setUsingParam ( int  paramType,
bool  yesNo = true 
)
virtual

Set/Get the "usage" state for the specified parameter type.

virtual bool MAKLogger::DtLgrArtPart::usingParam ( int  paramType) const
virtual

Friends And Related Function Documentation

friend class DtLgrArtPartList
friend

Member Data Documentation

unsigned int MAKLogger::DtLgrArtPart::myParamSetMask
protected
float MAKLogger::DtLgrArtPart::myParamVals[DtMAX_PARAMS_PER_PART+1]
protected
int MAKLogger::DtLgrArtPart::myPartAttachedTo
protected
int MAKLogger::DtLgrArtPart::myPartNum
protected

Referenced by partNum(), and setPartNum().

int MAKLogger::DtLgrArtPart::myPartType
protected

Referenced by partType(), and setPartType().


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

Document ID: Generated on Thu Apr 10 18:53:01 EDT 2014 from SVN revision 138105
Copyright © 2005-2012 VT MÄK. All Rights Reserved (www.mak.com)