HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
GEO_AttributeIndexPairs Class Reference

This class provides a convenient abstraction of the contents of an index pair attribute for a single element. More...

#include <GEO_AttributeIndexPairs.h>

Public Member Functions

 GEO_AttributeIndexPairs (GA_Offset elem_off, const GA_RWAttributeRef &ref)
 
 GEO_AttributeIndexPairs (GA_Offset elem_off, GA_Attribute *attrib, const GA_AIFIndexPair *aifindexpair)
 
 ~GEO_AttributeIndexPairs ()
 Destructor. More...
 
int32 getEntryIndex (int n) const
 
fpreal32 getEntryValue (int n, int component=0) const
 
void getEntry (int n, int32 &index, fpreal32 &value) const
 
void setEntryIndex (int n, int32 index)
 
void setEntryValue (int n, fpreal32 value, int component=0)
 
void setEntry (int n, int32 index, fpreal32 value)
 
void offsetEntryValue (int n, fpreal32 o, int component=0)
 
void scaleEntryValue (int n, fpreal32 s, int component=0)
 
void bind (GA_Offset elem_off, GA_Attribute *attrib, const GA_AIFIndexPair *aifindexpair)
 
void bind (GA_Offset elem_off, const GA_RWAttributeRef &ref)
 

Detailed Description

This class provides a convenient abstraction of the contents of an index pair attribute for a single element.

It is important to note that this class does not perform any sort of bounds checking.

Warning
This is being used internally by Side Effects to simplify forward compatibility issues. The lifetime of this class is not well known and code should not rely on any methods herein.

Definition at line 68 of file GEO_AttributeIndexPairs.h.

Constructor & Destructor Documentation

GEO_AttributeIndexPairs::GEO_AttributeIndexPairs ( GA_Offset  elem_off,
const GA_RWAttributeRef ref 
)
inline

No Default constructor. An instance must always be bound.

Precondition
ref.isValid() == true

Definition at line 73 of file GEO_AttributeIndexPairs.h.

GEO_AttributeIndexPairs::GEO_AttributeIndexPairs ( GA_Offset  elem_off,
GA_Attribute attrib,
const GA_AIFIndexPair aifindexpair 
)
inline

Definition at line 75 of file GEO_AttributeIndexPairs.h.

GEO_AttributeIndexPairs::~GEO_AttributeIndexPairs ( )
inline

Destructor.

Definition at line 80 of file GEO_AttributeIndexPairs.h.

Member Function Documentation

void GEO_AttributeIndexPairs::bind ( GA_Offset  elem_off,
GA_Attribute attrib,
const GA_AIFIndexPair aifindexpair 
)
inline

Bind a element

Precondition
ref.isValid() == true

Definition at line 85 of file GEO_AttributeIndexPairs.h.

void GEO_AttributeIndexPairs::bind ( GA_Offset  elem_off,
const GA_RWAttributeRef ref 
)

Bind a element

Precondition
ref.isValid() == true
void GEO_AttributeIndexPairs::getEntry ( int  n,
int32 index,
fpreal32 value 
) const
inline

Definition at line 97 of file GEO_AttributeIndexPairs.h.

int32 GEO_AttributeIndexPairs::getEntryIndex ( int  n) const
fpreal32 GEO_AttributeIndexPairs::getEntryValue ( int  n,
int  component = 0 
) const
void GEO_AttributeIndexPairs::offsetEntryValue ( int  n,
fpreal32  o,
int  component = 0 
)
inline

Definition at line 111 of file GEO_AttributeIndexPairs.h.

void GEO_AttributeIndexPairs::scaleEntryValue ( int  n,
fpreal32  s,
int  component = 0 
)
inline

Definition at line 113 of file GEO_AttributeIndexPairs.h.

void GEO_AttributeIndexPairs::setEntry ( int  n,
int32  index,
fpreal32  value 
)
inline

Definition at line 105 of file GEO_AttributeIndexPairs.h.

void GEO_AttributeIndexPairs::setEntryIndex ( int  n,
int32  index 
)
void GEO_AttributeIndexPairs::setEntryValue ( int  n,
fpreal32  value,
int  component = 0 
)

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