#include <HUSD_PropertyHandle.h>

Inheritance diagram for HUSD_PropertyHandle:

Public Member Functions
	HUSD_PropertyHandle ()

	HUSD_PropertyHandle (const HUSD_PrimHandle &prim_handle, const UT_StringRef &property_name)

	~HUSD_PropertyHandle () override

const HUSD_DataHandle &	dataHandle () const override

const HUSD_ConstOverridesPtr &	overrides () const override

const HUSD_ConstPostLayersPtr &	postLayers () const override

const HUSD_PrimHandle &	primHandle () const

UT_StringHolder	getSourceSchema () const

UT_StringHolder	getTypeDescription () const

bool	isCustom () const

bool	isXformOp () const

void	createScriptedParms (UT_Array< PI_EditScriptedParm * > &parms, const UT_StringRef &custom_name, bool prepend_control_parm, bool prefix_xform_parms) const

void	createScriptedConnectionParms (UT_Array< PI_EditScriptedParm * > &parms, const UT_StringRef &custom_name, bool prepend_control_parm) const

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

Static Public Member Functions
static UT_UniquePtr < PI_EditScriptedParm >	createScriptedControlParm (const UT_StringHolder &propbasename, const UT_StringRef &usdvaluetype, const UT_StringRef &usdvaluename=UT_StringRef(), bool add_value_control_items=true, bool add_connection_control_items=false)

static UT_StringHolder	getScriptedControlDisableCondition (const UT_StringRef &ctrl_parm_name, const UT_StringRef &usdvaluetype=UT_StringRef(), const UT_StringRef &usdvaluename=UT_StringRef())

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

Detailed Description

Definition at line 83 of file HUSD_PropertyHandle.h.

Constructor & Destructor Documentation

HUSD_PropertyHandle::HUSD_PropertyHandle ( )

HUSD_PropertyHandle::HUSD_PropertyHandle	(	const HUSD_PrimHandle &	prim_handle,
		const UT_StringRef &	property_name
	)

HUSD_PropertyHandle::~HUSD_PropertyHandle ( )

override

Member Function Documentation

void HUSD_PropertyHandle::createScriptedConnectionParms	(	UT_Array< PI_EditScriptedParm * > &	parms,
		const UT_StringRef &	custom_name,
		bool	prepend_control_parm
	)		const

Creates a parameter that can specify a connection (ie, a source attribute path) for the given input or output shading attribute. If prepend_control_parm is true, it also creates a control menu parm before the value parm. The control parm determines whether and how the USD property is edited. It appends the created parameter to the given parms array.

static UT_UniquePtr<PI_EditScriptedParm> HUSD_PropertyHandle::createScriptedControlParm	(	const UT_StringHolder &	propbasename,
		const UT_StringRef &	usdvaluetype,
		const UT_StringRef &	usdvaluename = `UT_StringRef()`,
		bool	add_value_control_items = `true`,
		bool	add_connection_control_items = `false`
	)

static

Returns a control parameter for the given USD property name. The given name can be also a node parameter name that corresponds or encodes the property name. Though the parm name can also be arbitrary (because usd prop name is stored as a parm tag), in which case the property name should be provided as usdvaluename parameter.

void HUSD_PropertyHandle::createScriptedParms	(	UT_Array< PI_EditScriptedParm * > &	parms,
		const UT_StringRef &	custom_name,
		bool	prepend_control_parm,
		bool	prefix_xform_parms
	)		const

Creates a parameter that can specify a new value for the given USD property. If prepend_control_parm is true, it also creates a control menu parm before the value parm. The control parm determines whether and how the USD property is edited. It appends the created parameters to the given parms array.

const HUSD_DataHandle& HUSD_PropertyHandle::dataHandle ( ) const

inlineoverridevirtual

Implements HUSD_ObjectHandle.

Definition at line 92 of file HUSD_PropertyHandle.h.

static UT_StringHolder HUSD_PropertyHandle::getScriptedControlDisableCondition	(	const UT_StringRef &	ctrl_parm_name,
		const UT_StringRef &	usdvaluetype = `UT_StringRef()`,
		const UT_StringRef &	usdvaluename = `UT_StringRef()`
	)

static

UT_StringHolder HUSD_PropertyHandle::getSourceSchema ( ) const

UT_StringHolder HUSD_PropertyHandle::getTypeDescription ( ) const

bool HUSD_PropertyHandle::isCustom ( ) const

bool HUSD_PropertyHandle::isXformOp ( ) const

const HUSD_ConstOverridesPtr& HUSD_PropertyHandle::overrides ( ) const

inlineoverridevirtual

Implements HUSD_ObjectHandle.

Definition at line 94 of file HUSD_PropertyHandle.h.

const HUSD_ConstPostLayersPtr& HUSD_PropertyHandle::postLayers ( ) const

inlineoverridevirtual

Implements HUSD_ObjectHandle.

Definition at line 96 of file HUSD_PropertyHandle.h.

const HUSD_PrimHandle& HUSD_PropertyHandle::primHandle ( ) const

inline

Definition at line 98 of file HUSD_PropertyHandle.h.

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

HUSD/HUSD_PropertyHandle.h

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation