#include <HUSD_GetAttributes.h>

Public Member Functions
	HUSD_GetAttributes (HUSD_AutoAnyLock &lock)

	~HUSD_GetAttributes ()

bool	getAttributeArraySize (const UT_StringRef &primpath, const UT_StringRef &attribname, size_t &arraylength, const HUSD_TimeCode &timecode) const

UT_StringHolder	getAttributeInterpolation (const UT_StringRef &primpath, const UT_StringRef &primvarname) const

template<typename UtValueType >
bool	getFlattenedPrimvar (const UT_StringRef &primpath, const UT_StringRef &primvarname, UT_Array< UtValueType > &value, const HUSD_TimeCode &timecode, bool allow_inheritance=false) const
	Obtains array value of a flattened primvar. More...

bool	isPrimvarIndexed (const UT_StringRef &primpath, const UT_StringRef &primvarname, bool allow_inheritance=false) const
	Returns true if the primvar is indexed. More...

bool	getPrimvarIndices (const UT_StringRef &primpath, const UT_StringRef &primvarname, UT_ExintArray &indices, const HUSD_TimeCode &timecode, bool allow_inheritance=false) const
	Returns the index array for indexed primvars. More...

UT_StringHolder	getPrimvarInterpolation (const UT_StringRef &primpath, const UT_StringRef &primvarname, bool allow_inheritance=false) const
	Returns the interpolation style of a primvar. More...

exint	getPrimvarElementSize (const UT_StringRef &primpath, const UT_StringRef &primvarname, bool allow_inheritance=false) const
	Returns the element size of a primvar. More...

bool	getIsTimeVarying () const
	Returns true if any attribute we have fetched has many time samples. More...

HUSD_TimeSampling	getTimeSampling () const
	Returns the overall sampling of fetched attributes. More...

void	resetTimeSampling ()


template<typename UtValueType >
bool	getAttribute (const UT_StringRef &primpath, const UT_StringRef &attribname, UtValueType &value, const HUSD_TimeCode &timecode) const
	Obtains attribute or primvar value. More...

template<typename UtValueType >
bool	getPrimvar (const UT_StringRef &primpath, const UT_StringRef &primvarname, UtValueType &value, const HUSD_TimeCode &timecode, bool allow_inheritance=false) const
	Obtains attribute or primvar value. More...

template<typename UtValueType >
bool	getAttributeOrPrimvar (const UT_StringRef &primpath, const UT_StringRef &name, UtValueType &value, const HUSD_TimeCode &timecode, bool flatten_primvar=false) const
	Obtains attribute or primvar value. More...


template<typename UtValueType >
bool	getAttributeArray (const UT_StringRef &primpath, const UT_StringRef &attribname, UT_Array< UtValueType > &value, const HUSD_TimeCode &timecode) const
	Obtains attribute or primvar array value. More...

template<typename UtValueType >
bool	getPrimvarArray (const UT_StringRef &primpath, const UT_StringRef &primvarname, UT_Array< UtValueType > &value, const HUSD_TimeCode &timecode, bool allow_inheritance=false) const
	Obtains attribute or primvar array value. More...

template<typename UtValueType >
bool	getAttributeOrPrimvarArray (const UT_StringRef &primpath, const UT_StringRef &name, UT_Array< UtValueType > &value, const HUSD_TimeCode &timecode, bool flatten_primvar=false) const
	Obtains attribute or primvar array value. More...

Detailed Description

Definition at line 29 of file HUSD_GetAttributes.h.

Constructor & Destructor Documentation

HUSD_GetAttributes::HUSD_GetAttributes ( HUSD_AutoAnyLock & lock )

HUSD_GetAttributes::~HUSD_GetAttributes ( )

Member Function Documentation

template<typename UtValueType >

bool HUSD_GetAttributes::getAttribute	(	const UT_StringRef &	primpath,
		const UT_StringRef &	attribname,
		UtValueType &	value,
		const HUSD_TimeCode &	timecode
	)		const

Obtains attribute or primvar value.

template<typename UtValueType >

bool HUSD_GetAttributes::getAttributeArray	(	const UT_StringRef &	primpath,
		const UT_StringRef &	attribname,
		UT_Array< UtValueType > &	value,
		const HUSD_TimeCode &	timecode
	)		const

inline

Obtains attribute or primvar array value.

Definition at line 62 of file HUSD_GetAttributes.h.

bool HUSD_GetAttributes::getAttributeArraySize	(	const UT_StringRef &	primpath,
		const UT_StringRef &	attribname,
		size_t &	arraylength,
		const HUSD_TimeCode &	timecode
	)		const

Obtains the size of an array attribute (0 if the attribute is not an array)

UT_StringHolder HUSD_GetAttributes::getAttributeInterpolation	(	const UT_StringRef &	primpath,
		const UT_StringRef &	primvarname
	)		const

Returns the interpolation style of an attribute. This is only valid for certain attributes, e.g. UsdGeomPoints 'widths'.

template<typename UtValueType >

bool HUSD_GetAttributes::getAttributeOrPrimvar	(	const UT_StringRef &	primpath,
		const UT_StringRef &	name,
		UtValueType &	value,
		const HUSD_TimeCode &	timecode,
		bool	flatten_primvar = `false`
	)		const

Obtains attribute or primvar value.

template<typename UtValueType >

bool HUSD_GetAttributes::getAttributeOrPrimvarArray	(	const UT_StringRef &	primpath,
		const UT_StringRef &	name,
		UT_Array< UtValueType > &	value,
		const HUSD_TimeCode &	timecode,
		bool	flatten_primvar = `false`
	)		const

inline

Obtains attribute or primvar array value.

Definition at line 78 of file HUSD_GetAttributes.h.

template<typename UtValueType >

bool HUSD_GetAttributes::getFlattenedPrimvar	(	const UT_StringRef &	primpath,
		const UT_StringRef &	primvarname,
		UT_Array< UtValueType > &	value,
		const HUSD_TimeCode &	timecode,
		bool	allow_inheritance = `false`
	)		const

Obtains array value of a flattened primvar.

bool HUSD_GetAttributes::getIsTimeVarying ( ) const

Returns true if any attribute we have fetched has many time samples.

template<typename UtValueType >

bool HUSD_GetAttributes::getPrimvar	(	const UT_StringRef &	primpath,
		const UT_StringRef &	primvarname,
		UtValueType &	value,
		const HUSD_TimeCode &	timecode,
		bool	allow_inheritance = `false`
	)		const

Obtains attribute or primvar value.

template<typename UtValueType >

bool HUSD_GetAttributes::getPrimvarArray	(	const UT_StringRef &	primpath,
		const UT_StringRef &	primvarname,
		UT_Array< UtValueType > &	value,
		const HUSD_TimeCode &	timecode,
		bool	allow_inheritance = `false`
	)		const

inline

Obtains attribute or primvar array value.

Definition at line 69 of file HUSD_GetAttributes.h.

exint HUSD_GetAttributes::getPrimvarElementSize	(	const UT_StringRef &	primpath,
		const UT_StringRef &	primvarname,
		bool	allow_inheritance = `false`
	)		const

Returns the element size of a primvar.

bool HUSD_GetAttributes::getPrimvarIndices	(	const UT_StringRef &	primpath,
		const UT_StringRef &	primvarname,
		UT_ExintArray &	indices,
		const HUSD_TimeCode &	timecode,
		bool	allow_inheritance = `false`
	)		const

Returns the index array for indexed primvars.

UT_StringHolder HUSD_GetAttributes::getPrimvarInterpolation	(	const UT_StringRef &	primpath,
		const UT_StringRef &	primvarname,
		bool	allow_inheritance = `false`
	)		const

Returns the interpolation style of a primvar.

HUSD_TimeSampling HUSD_GetAttributes::getTimeSampling ( ) const

inline

Returns the overall sampling of fetched attributes.

Definition at line 136 of file HUSD_GetAttributes.h.

bool HUSD_GetAttributes::isPrimvarIndexed	(	const UT_StringRef &	primpath,
		const UT_StringRef &	primvarname,
		bool	allow_inheritance = `false`
	)		const

Returns true if the primvar is indexed.

void HUSD_GetAttributes::resetTimeSampling ( )

Resets the time sampling tracker (i.e., forgetting whether any previously fetched attributes were time sampled or not).

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

HUSD/HUSD_GetAttributes.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation