#include <HUSD_ConfigurePrims.h>

Public Types
enum	Visibility { VISIBILITY_INHERIT, VISIBILITY_INVISIBLE, VISIBILITY_VISIBLE }

enum	Clear { NO_CLEAR, CLEAR }

Public Member Functions
	HUSD_ConfigurePrims (HUSD_AutoWriteLock &lock)

	~HUSD_ConfigurePrims ()

bool	setType (const HUSD_FindPrims &findprims, const UT_StringRef &primtype) const

bool	setSpecifier (const HUSD_FindPrims &findprims, const UT_StringRef &specifier) const

bool	setActive (const HUSD_FindPrims &findprims, bool active) const

bool	makePrimsAndAncestorsActive (const HUSD_PathSet &pathset, bool emit_warning_on_action=false) const

bool	setKind (const HUSD_FindPrims &findprims, const UT_StringRef &kind) const

bool	fixKindHierarchy (const HUSD_FindPrims &findprims) const

bool	fixGprimHierarchy (const HUSD_FindPrims &findprims) const

bool	fixPrimvarInterpolation (const HUSD_FindPrims &findprims, const UT_StringHolder &primvarPath) const

bool	setDrawMode (const HUSD_FindPrims &findprims, const UT_StringRef &drawmode) const

bool	setApplyDrawMode (const HUSD_FindPrims &findprim, bool apply) const

bool	setPurpose (const HUSD_FindPrims &findprims, const UT_StringRef &purpose) const

bool	setProxy (const HUSD_FindPrims &findprims, const UT_StringRef &proxy) const

bool	setInstanceable (const HUSD_FindPrims &findprims, bool instanceable) const

bool	setInvisible (const HUSD_FindPrims &findprims, Visibility vis, const HUSD_TimeCode &timecode, bool ignore_time_varying_stage) const

bool	setVariantSelection (const HUSD_FindPrims &findprims, const UT_StringRef &variantset, const UT_StringRef &variant) const

bool	setComputedExtents (const HUSD_FindPrims &findprims, const HUSD_TimeCode &timecode, Clear clear, HUSD_PathSet *overwrite_prims=nullptr) const

bool	setAssetName (const HUSD_FindPrims &findprims, const UT_StringRef &name) const

bool	setAssetIdentifier (const HUSD_FindPrims &findprims, const UT_StringRef &identifier) const

bool	setAssetVersion (const HUSD_FindPrims &findprims, const UT_StringRef &version) const

bool	setAssetDependencies (const HUSD_FindPrims &findprims, const UT_StringArray &dependencies) const

template<typename UtValueType >
bool	setAssetInfo (const HUSD_FindPrims &findprims, const UT_StringRef &key, const UtValueType &value) const

bool	removeAssetInfo (const HUSD_FindPrims &findprims, const UT_StringRef &key) const

bool	clearAssetInfo (const HUSD_FindPrims &findprims) const

bool	setEditable (const HUSD_FindPrims &findprims, bool editable) const

bool	setSelectable (const HUSD_FindPrims &findprims, bool selectable) const

bool	setHideInUi (const HUSD_FindPrims &findprims, bool hide) const

bool	addEditorNodeId (const HUSD_FindPrims &findprims, int nodeid) const

bool	clearEditorNodeIds (const HUSD_FindPrims &findprims) const

bool	applyAPI (const HUSD_FindPrims &findprims, const UT_StringRef &schema) const

bool	applyAPI (const HUSD_FindPrims &findprims, const UT_StringRef &schema, UT_StringSet *failedapis) const

bool	getIsTimeVarying () const

Detailed Description

Definition at line 29 of file HUSD_ConfigurePrims.h.

Member Enumeration Documentation

enum HUSD_ConfigurePrims::Clear

Enumerator
NO_CLEAR
CLEAR

Definition at line 87 of file HUSD_ConfigurePrims.h.

enum HUSD_ConfigurePrims::Visibility

Enumerator
VISIBILITY_INHERIT
VISIBILITY_INVISIBLE
VISIBILITY_VISIBLE

Definition at line 74 of file HUSD_ConfigurePrims.h.

Constructor & Destructor Documentation

HUSD_ConfigurePrims::HUSD_ConfigurePrims ( HUSD_AutoWriteLock & lock )

HUSD_ConfigurePrims::~HUSD_ConfigurePrims ( )

Member Function Documentation

bool HUSD_ConfigurePrims::addEditorNodeId	(	const HUSD_FindPrims &	findprims,
		int	nodeid
	)		const

bool HUSD_ConfigurePrims::applyAPI	(	const HUSD_FindPrims &	findprims,
		const UT_StringRef &	schema
	)		const

bool HUSD_ConfigurePrims::applyAPI	(	const HUSD_FindPrims &	findprims,
		const UT_StringRef &	schema,
		UT_StringSet *	failedapis
	)		const

bool HUSD_ConfigurePrims::clearAssetInfo ( const HUSD_FindPrims & findprims ) const

bool HUSD_ConfigurePrims::clearEditorNodeIds ( const HUSD_FindPrims & findprims ) const

bool HUSD_ConfigurePrims::fixGprimHierarchy ( const HUSD_FindPrims & findprims ) const

bool HUSD_ConfigurePrims::fixKindHierarchy ( const HUSD_FindPrims & findprims ) const

bool HUSD_ConfigurePrims::fixPrimvarInterpolation	(	const HUSD_FindPrims &	findprims,
		const UT_StringHolder &	primvarPath
	)		const

bool HUSD_ConfigurePrims::getIsTimeVarying ( ) const

bool HUSD_ConfigurePrims::makePrimsAndAncestorsActive	(	const HUSD_PathSet &	pathset,
		bool	emit_warning_on_action = `false`
	)		const

Forces the effective activation of a given set of prims by traversing the prim hierarchy and manipulating ancestor prims' active status.

This is somewhat akin to MakeVisible in UsdGeomImageable.

As this can be used in a corrective context, it can optionally emit a warning message if any maniption actually takes place.

NOTE: Unlike the rest of the methods in this class, we do not accept a HUSD_FindPrims as it will fail to actually find prims that have inactive ancestors (this is by design in USD)

NOTE: This function will not work if run while there is an active Sdf change block (and there doesn't seem to be a way to check)

bool HUSD_ConfigurePrims::removeAssetInfo	(	const HUSD_FindPrims &	findprims,
		const UT_StringRef &	key
	)		const

bool HUSD_ConfigurePrims::setActive	(	const HUSD_FindPrims &	findprims,
		bool	active
	)		const

bool HUSD_ConfigurePrims::setApplyDrawMode	(	const HUSD_FindPrims &	findprim,
		bool	apply
	)		const

bool HUSD_ConfigurePrims::setAssetDependencies	(	const HUSD_FindPrims &	findprims,
		const UT_StringArray &	dependencies
	)		const

bool HUSD_ConfigurePrims::setAssetIdentifier	(	const HUSD_FindPrims &	findprims,
		const UT_StringRef &	identifier
	)		const

template<typename UtValueType >

bool HUSD_ConfigurePrims::setAssetInfo	(	const HUSD_FindPrims &	findprims,
		const UT_StringRef &	key,
		const UtValueType &	value
	)		const

bool HUSD_ConfigurePrims::setAssetName	(	const HUSD_FindPrims &	findprims,
		const UT_StringRef &	name
	)		const

bool HUSD_ConfigurePrims::setAssetVersion	(	const HUSD_FindPrims &	findprims,
		const UT_StringRef &	version
	)		const

bool HUSD_ConfigurePrims::setComputedExtents	(	const HUSD_FindPrims &	findprims,
		const HUSD_TimeCode &	timecode,
		Clear	clear,
		HUSD_PathSet *	overwrite_prims = `nullptr`
	)		const

bool HUSD_ConfigurePrims::setDrawMode	(	const HUSD_FindPrims &	findprims,
		const UT_StringRef &	drawmode
	)		const

bool HUSD_ConfigurePrims::setEditable	(	const HUSD_FindPrims &	findprims,
		bool	editable
	)		const

bool HUSD_ConfigurePrims::setHideInUi	(	const HUSD_FindPrims &	findprims,
		bool	hide
	)		const

bool HUSD_ConfigurePrims::setInstanceable	(	const HUSD_FindPrims &	findprims,
		bool	instanceable
	)		const

bool HUSD_ConfigurePrims::setInvisible	(	const HUSD_FindPrims &	findprims,
		Visibility	vis,
		const HUSD_TimeCode &	timecode,
		bool	ignore_time_varying_stage
	)		const

bool HUSD_ConfigurePrims::setKind	(	const HUSD_FindPrims &	findprims,
		const UT_StringRef &	kind
	)		const

bool HUSD_ConfigurePrims::setProxy	(	const HUSD_FindPrims &	findprims,
		const UT_StringRef &	proxy
	)		const

bool HUSD_ConfigurePrims::setPurpose	(	const HUSD_FindPrims &	findprims,
		const UT_StringRef &	purpose
	)		const

bool HUSD_ConfigurePrims::setSelectable	(	const HUSD_FindPrims &	findprims,
		bool	selectable
	)		const

bool HUSD_ConfigurePrims::setSpecifier	(	const HUSD_FindPrims &	findprims,
		const UT_StringRef &	specifier
	)		const

bool HUSD_ConfigurePrims::setType	(	const HUSD_FindPrims &	findprims,
		const UT_StringRef &	primtype
	)		const

bool HUSD_ConfigurePrims::setVariantSelection	(	const HUSD_FindPrims &	findprims,
		const UT_StringRef &	variantset,
		const UT_StringRef &	variant
	)		const

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

HUSD/HUSD_ConfigurePrims.h

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation