HUSD_PrimHandle Class Reference

#include <HUSD_PrimHandle.h>

Inheritance diagram for HUSD_PrimHandle:

Public Member Functions
	HUSD_PrimHandle ()
	HUSD_PrimHandle (const HUSD_DataHandle &data_handle, const HUSD_Path &prim_path=HUSD_Path::theRootPrimPath)
	HUSD_PrimHandle (const HUSD_DataHandle &data_handle, const HUSD_ConstOverridesPtr &overrides, const HUSD_ConstPostLayersPtr &postlayers, OverridesHandling overrides_handling, const HUSD_Path &prim_path=HUSD_Path::theRootPrimPath)
	~HUSD_PrimHandle () override
const HUSD_DataHandle &	dataHandle () const override
const HUSD_ConstOverridesPtr &	overrides () const override
const HUSD_ConstPostLayersPtr &	postLayers () const override
HUSD_PrimStatus	getStatus () const
UT_StringHolder	getPrimType () const
UT_StringHolder	getVariantInfo () const
UT_StringHolder	getKind (bool *kind_is_valid) const
UT_StringHolder	getDrawMode (bool *has_override=nullptr) const
UT_StringHolder	getPurpose () const
HUSD_MaterialInfo	getMaterialInfo () const
UT_StringHolder	getProxyPath () const
UT_StringHolder	getAncestorPayloadPath () const
UT_StringHolder	getSpecifier () const
UT_StringHolder	getIcon () const
HUSD_PrimAttribState	getActive () const
HUSD_PrimAttribState	getVisible (const HUSD_TimeCode &timecode) const
HUSD_PrimAttribState	getSelectable () const
HUSD_SoloState	getSoloState () const
int64	getChildCount (HUSD_PrimTraversalDemands demands) const
int64	getDescendantCount (HUSD_PrimTraversalDemands demands) const
bool	hasAnyOverrides () const
bool	hasAnyPostLayers () const
bool	hasPayload () const
bool	isDefined () const
bool	isHiddenInUi () const
bool	isEditable () const
bool	hasChildren (HUSD_PrimTraversalDemands demands) const
void	getChildren (UT_Array< HUSD_PrimHandle > &children, HUSD_PrimTraversalDemands demands) const
void	getProperties (UT_Array< HUSD_PropertyHandle > &props, bool include_attributes, bool include_relationships, bool include_shader_inputs) const
void	getAttributeNames (UT_ArrayStringSet &attrib_names) const
void	extractAttributes (const UT_ArrayStringSet &which_attribs, const HUSD_TimeCode &tc, UT_Options &values)
Public Member Functions inherited from HUSD_ObjectHandle
	HUSD_ObjectHandle (OverridesHandling overrides_handling=OVERRIDES_IGNORE)
	HUSD_ObjectHandle (const HUSD_Path &path, OverridesHandling overrides_handling=OVERRIDES_IGNORE)
virtual	~HUSD_ObjectHandle ()
OverridesHandling	overridesHandling () const
const HUSD_Path &	path () const
bool	isValid () const

Additional Inherited Members
Public Types inherited from HUSD_ObjectHandle
enum	OverridesHandling { OVERRIDES_COMPOSE, OVERRIDES_INSPECT, OVERRIDES_IGNORE }

Detailed Description

Definition at line 97 of file HUSD_PrimHandle.h.

Constructor & Destructor Documentation

HUSD_PrimHandle::HUSD_PrimHandle

(

)

HUSD_PrimHandle::HUSD_PrimHandle	(	const HUSD_DataHandle &	data_handle,
		const HUSD_Path &	prim_path = HUSD_Path::theRootPrimPath
	)

HUSD_PrimHandle::HUSD_PrimHandle	(	const HUSD_DataHandle &	data_handle,
		const HUSD_ConstOverridesPtr &	overrides,
		const HUSD_ConstPostLayersPtr &	postlayers,
		OverridesHandling	overrides_handling,
		const HUSD_Path &	prim_path = HUSD_Path::theRootPrimPath
	)

HUSD_PrimHandle::~HUSD_PrimHandle ( )

override

Member Function Documentation

const HUSD_DataHandle& HUSD_PrimHandle::dataHandle ( ) const

overridevirtual

Implements HUSD_ObjectHandle.

void HUSD_PrimHandle::extractAttributes	(	const UT_ArrayStringSet &	which_attribs,
		const HUSD_TimeCode &	tc,
		UT_Options &	values
	)

HUSD_PrimAttribState HUSD_PrimHandle::getActive

(

)

const

UT_StringHolder HUSD_PrimHandle::getAncestorPayloadPath

(

)

const

void HUSD_PrimHandle::getAttributeNames

(

UT_ArrayStringSet &

attrib_names

)

const

int64 HUSD_PrimHandle::getChildCount

(

HUSD_PrimTraversalDemands

demands

)

const

void HUSD_PrimHandle::getChildren	(	UT_Array< HUSD_PrimHandle > &	children,
		HUSD_PrimTraversalDemands	demands
	)		const

int64 HUSD_PrimHandle::getDescendantCount

(

HUSD_PrimTraversalDemands

demands

)

const

UT_StringHolder HUSD_PrimHandle::getDrawMode

(

bool *

has_override = nullptr

)

const

UT_StringHolder HUSD_PrimHandle::getIcon

(

)

const

UT_StringHolder HUSD_PrimHandle::getKind

(

bool *

kind_is_valid

)

const

HUSD_MaterialInfo HUSD_PrimHandle::getMaterialInfo

(

)

const

UT_StringHolder HUSD_PrimHandle::getPrimType

(

)

const

void HUSD_PrimHandle::getProperties	(	UT_Array< HUSD_PropertyHandle > &	props,
		bool	include_attributes,
		bool	include_relationships,
		bool	include_shader_inputs
	)		const

UT_StringHolder HUSD_PrimHandle::getProxyPath

(

)

const

UT_StringHolder HUSD_PrimHandle::getPurpose

(

)

const

HUSD_PrimAttribState HUSD_PrimHandle::getSelectable

(

)

const

HUSD_SoloState HUSD_PrimHandle::getSoloState

(

)

const

UT_StringHolder HUSD_PrimHandle::getSpecifier

(

)

const

HUSD_PrimStatus HUSD_PrimHandle::getStatus

(

)

const

UT_StringHolder HUSD_PrimHandle::getVariantInfo

(

)

const

HUSD_PrimAttribState HUSD_PrimHandle::getVisible

(

const HUSD_TimeCode &

timecode

)

const

bool HUSD_PrimHandle::hasAnyOverrides

(

)

const

bool HUSD_PrimHandle::hasAnyPostLayers

(

)

const

bool HUSD_PrimHandle::hasChildren

(

HUSD_PrimTraversalDemands

demands

)

const

bool HUSD_PrimHandle::hasPayload

(

)

const

bool HUSD_PrimHandle::isDefined

(

)

const

bool HUSD_PrimHandle::isEditable

(

)

const

bool HUSD_PrimHandle::isHiddenInUi

(

)

const

const HUSD_ConstOverridesPtr& HUSD_PrimHandle::overrides ( ) const

overridevirtual

Implements HUSD_ObjectHandle.

const HUSD_ConstPostLayersPtr& HUSD_PrimHandle::postLayers ( ) const

overridevirtual

Implements HUSD_ObjectHandle.

---

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

• HUSD/HUSD_PrimHandle.h