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...
const UT_StringHolder &	captAttribName () const
const GU_Detail *	srcGdp () 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
	Number of points in the range given to init(). More...
int	numRegions () const
	Return the number of regions found by initSrc() More...
const UT_StringHolder &	regionName (int i) const
const UT_Matrix4F &	regionXform (int i) const
bool	haveRegionXforms () const
	Return if myRegionXforms has been initialized. More...
bool	usesRegion (int i) const
CaptureElementRange	captureElementRange (exint ptidx) const
	Returns the range of capture elements for the given point index. More...
int	init (const GU_Detail &src, const GA_Range &pt_range, bool use_opencl=false, int max_pt_weights=0)
int	init (const GU_Detail &src, const GA_Range &pt_range, const UT_StringRef &capt_attrib_name, bool use_opencl=false, int max_pt_weights=0)

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, bool &have_region_xforms)
static bool	getCaptureParms (const GU_Detail &src, const UT_StringRef &capt_attrib_name, GA_ROAttributeRef &pcapt, GEO_AttributeCapturePath &attr_cap_path, UT_Array< UT_Matrix4F > &xforms, int &max_pt_regions, bool &have_region_xforms)

Friends
class	GU_LinearSkinDeformer

Detailed Description

Class representing source capture weight data for GU_LinearSkinDeformer.

Definition at line 175 of file GU_LinearSkinDeformer.h.

Member Typedef Documentation

using GU_LinearSkinDeformerSourceWeights::CaptureElementRange = UT_IteratorRange<GU_CaptureElementArray::const_iterator>

Definition at line 267 of file GU_LinearSkinDeformer.h.

Constructor & Destructor Documentation

GU_LinearSkinDeformerSourceWeights::GU_LinearSkinDeformerSourceWeights

(

)

Member Function Documentation

const UT_StringHolder& GU_LinearSkinDeformerSourceWeights::captAttribName ( ) const

inline

Definition at line 204 of file GU_LinearSkinDeformer.h.

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

inline

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

Definition at line 316 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, bool &  have_region_xforms  )

static

Static utility method to get capture parameters

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

static

Static utility method to get capture parameters

int64 GU_LinearSkinDeformerSourceWeights::getMemoryUsage

(

bool

inclusive

)

const

bool GU_LinearSkinDeformerSourceWeights::haveRegionXforms ( ) const

inline

Return if myRegionXforms has been initialized.

Definition at line 239 of file GU_LinearSkinDeformer.h.

int GU_LinearSkinDeformerSourceWeights::init	(	const GU_Detail &	src,
		const GA_Range &	pt_range,
		bool	use_opencl = false,
		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.

int GU_LinearSkinDeformerSourceWeights::init	(	const GU_Detail &	src,
		const GA_Range &	pt_range,
		const UT_StringRef &	capt_attrib_name,
		bool	use_opencl = false,
		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

Number of points in the range given to init().

Definition at line 222 of file GU_LinearSkinDeformer.h.

int GU_LinearSkinDeformerSourceWeights::numRegions ( ) const

inline

Return the number of regions found by initSrc()

Definition at line 225 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 230 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 235 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 209 of file GU_LinearSkinDeformer.h.

const GU_Detail* GU_LinearSkinDeformerSourceWeights::srcGdp ( ) const

inline

Definition at line 207 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 244 of file GU_LinearSkinDeformer.h.

Friends And Related Function Documentation

friend class GU_LinearSkinDeformer

friend

Definition at line 312 of file GU_LinearSkinDeformer.h.

---

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

• GU/GU_LinearSkinDeformer.h