HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
GA_ROGenericHandle< T, T_OWNER > Class Template Reference

#include <GA_GenericHandle.h>

+ Inheritance diagram for GA_ROGenericHandle< T, T_OWNER >:

Public Member Functions

 GA_ROGenericHandle (const GA_Attribute *attr, int component=0, bool forceisp=false)
 
const GA_AttributegetAttribute () const
 
bool isRational () const
 
T getValue (GA_Offset off) const
 
T getHomogeneous (GA_Offset off) const
 
bool isForcedP () const
 

Protected Attributes

GA_RWHandleT< TmyHandle
 
int myComponent
 
bool myConst
 
bool myIsRational
 
bool myIsForcedP
 

Detailed Description

template<typename T, GA_AttributeOwner T_OWNER>
class GA_ROGenericHandle< T, T_OWNER >

Read-only generic handle.

The handle provides read-only access to attributedata. The T template parameter can be specialized with

  • float
  • UT_Vector2
  • UT_Vector3
  • UT_Vector4 (see specializations below)
  • UT_Matrix3
  • UT_Matrix4
  • GA_Offset (see specializations below) The T_OWNER parameter can be specialized with
  • GA_ATTRIB_POINT
    Point offsets will be passeed to math.getValue(). Only point attributes will be modified for GA_Offset specializations.
  • GA_ATTRIB_VERTEX Vertex offsets must be passed to math.getValue(). Both point and vertex attributes will be modified with the GA_Offset specialization.

The offsets passed to getValue() must match the T_OWNER template parameter.

Definition at line 78 of file GA_GenericHandle.h.

Constructor & Destructor Documentation

template<typename T, GA_AttributeOwner T_OWNER>
GA_ROGenericHandle< T, T_OWNER >::GA_ROGenericHandle ( const GA_Attribute attr,
int  component = 0,
bool  forceisp = false 
)
inline

Definition at line 81 of file GA_GenericHandle.h.

Member Function Documentation

template<typename T, GA_AttributeOwner T_OWNER>
const GA_Attribute* GA_ROGenericHandle< T, T_OWNER >::getAttribute ( ) const
inline

Definition at line 91 of file GA_GenericHandle.h.

template<typename T, GA_AttributeOwner T_OWNER>
T GA_ROGenericHandle< T, T_OWNER >::getHomogeneous ( GA_Offset  off) const
inline

Definition at line 117 of file GA_GenericHandle.h.

template<typename T, GA_AttributeOwner T_OWNER>
T GA_ROGenericHandle< T, T_OWNER >::getValue ( GA_Offset  off) const
inline

Definition at line 96 of file GA_GenericHandle.h.

template<typename T, GA_AttributeOwner T_OWNER>
bool GA_ROGenericHandle< T, T_OWNER >::isForcedP ( ) const
inline

Definition at line 122 of file GA_GenericHandle.h.

template<typename T, GA_AttributeOwner T_OWNER>
bool GA_ROGenericHandle< T, T_OWNER >::isRational ( ) const
inline

Definition at line 93 of file GA_GenericHandle.h.

Member Data Documentation

template<typename T, GA_AttributeOwner T_OWNER>
int GA_ROGenericHandle< T, T_OWNER >::myComponent
protected

Definition at line 127 of file GA_GenericHandle.h.

template<typename T, GA_AttributeOwner T_OWNER>
bool GA_ROGenericHandle< T, T_OWNER >::myConst
protected

Definition at line 128 of file GA_GenericHandle.h.

template<typename T, GA_AttributeOwner T_OWNER>
GA_RWHandleT<T> GA_ROGenericHandle< T, T_OWNER >::myHandle
protected

Definition at line 126 of file GA_GenericHandle.h.

template<typename T, GA_AttributeOwner T_OWNER>
bool GA_ROGenericHandle< T, T_OWNER >::myIsForcedP
protected

Definition at line 130 of file GA_GenericHandle.h.

template<typename T, GA_AttributeOwner T_OWNER>
bool GA_ROGenericHandle< T, T_OWNER >::myIsRational
protected

Definition at line 129 of file GA_GenericHandle.h.


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