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

Class representing source capture weight data for GU_LinearSkinDeformer. More...

#include <GU_LinearSkinDeformer.h>

+ Inheritance diagram for GU_LinearSkinDeformerSourceWeights:

Public Types

using CaptureElementRange = UT_IteratorRange< GU_CaptureElementArray::const_iterator >
 

Public Member Functions

 GU_LinearSkinDeformerSourceWeights ()
 
int64 getMemoryUsage (bool inclusive) const
 
void reset ()
 Reset all state. More...
 
int init (const GU_Detail &src, const GA_Range &pt_range, int max_pt_weights=0)
 
const GU_DetailsrcGdp () const
 
void setSrcGdp (const GU_Detail &src)
 
bool setRegionXformsFromGeo (const GU_Detail &rest_skel, const GA_Attribute &P, const GA_Attribute &name, const GA_Attribute &transform)
 
exint numPoints () const
 
int numRegions () const
 Return the number of regions found by initSrc() More...
 
const UT_StringHolderregionName (int i) const
 
const UT_Matrix4FregionXform (int i) const
 
bool usesRegion (int i) const
 
CaptureElementRange captureElementRange (exint ptidx) const
 Returns the range of capture elements for the given point index. More...
 

Static Public Member Functions

static bool getCaptureParms (const GU_Detail &src, GA_ROAttributeRef &pcapt, GEO_AttributeCapturePath &attr_cap_path, UT_Array< UT_Matrix4F > &xforms, int &max_pt_regions)
 Static utility method to get capture parameters. More...
 

Friends

class GU_LinearSkinDeformer
 

Detailed Description

Class representing source capture weight data for GU_LinearSkinDeformer.

Definition at line 156 of file GU_LinearSkinDeformer.h.

Member Typedef Documentation

Constructor & Destructor Documentation

GU_LinearSkinDeformerSourceWeights::GU_LinearSkinDeformerSourceWeights ( )

Member Function Documentation

GU_LinearSkinDeformerSourceWeights::CaptureElementRange GU_LinearSkinDeformerSourceWeights::captureElementRange ( exint  ptidx) const
inline

Returns the range of capture elements for the given point index.

Definition at line 245 of file GU_LinearSkinDeformer.h.

static bool GU_LinearSkinDeformerSourceWeights::getCaptureParms ( const GU_Detail src,
GA_ROAttributeRef pcapt,
GEO_AttributeCapturePath attr_cap_path,
UT_Array< UT_Matrix4F > &  xforms,
int max_pt_regions 
)
static

Static utility method to get capture parameters.

int64 GU_LinearSkinDeformerSourceWeights::getMemoryUsage ( bool  inclusive) const
int GU_LinearSkinDeformerSourceWeights::init ( const GU_Detail src,
const GA_Range pt_range,
int  max_pt_weights = 0 
)

Set up from the source geometry. Returns the number of transforms required to deform using the capture weight attribute. If in error, then 0 is returned. If max_pt_weights > 0, then it will limit the number of weight entries to use per point.

exint GU_LinearSkinDeformerSourceWeights::numPoints ( ) const
inline

Definition at line 190 of file GU_LinearSkinDeformer.h.

int GU_LinearSkinDeformerSourceWeights::numRegions ( ) const
inline

Return the number of regions found by initSrc()

Definition at line 195 of file GU_LinearSkinDeformer.h.

const UT_StringHolder& GU_LinearSkinDeformerSourceWeights::regionName ( int  i) const
inline

Return the name given the region index. init() must have been called first.

Definition at line 200 of file GU_LinearSkinDeformer.h.

const UT_Matrix4F& GU_LinearSkinDeformerSourceWeights::regionXform ( int  i) const
inline

Return the transform given the region index. init() must have been called first.

Definition at line 205 of file GU_LinearSkinDeformer.h.

void GU_LinearSkinDeformerSourceWeights::reset ( )

Reset all state.

bool GU_LinearSkinDeformerSourceWeights::setRegionXformsFromGeo ( const GU_Detail rest_skel,
const GA_Attribute P,
const GA_Attribute name,
const GA_Attribute transform 
)

Set new region transforms from point skeleton geometry with P, name, and transform. It will invert transform to match what getCaptureParms() returns.

void GU_LinearSkinDeformerSourceWeights::setSrcGdp ( const GU_Detail src)
inline

Definition at line 178 of file GU_LinearSkinDeformer.h.

const GU_Detail* GU_LinearSkinDeformerSourceWeights::srcGdp ( ) const
inline

Definition at line 176 of file GU_LinearSkinDeformer.h.

bool GU_LinearSkinDeformerSourceWeights::usesRegion ( int  i) const
inline

Returns whether the region is referenced by at least one capture element.

Definition at line 210 of file GU_LinearSkinDeformer.h.

Friends And Related Function Documentation

Definition at line 241 of file GU_LinearSkinDeformer.h.


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