Class UsdShadeInput

Inheritance

Object

UsdShadeInput

Inherited Members

Object.ToString()

Object.Equals(Object)

Object.Equals(Object, Object)

Object.ReferenceEquals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Namespace: pxr

Syntax

public class UsdShadeInput : IDisposable

Constructors

UsdShadeInput()

Declaration

public UsdShadeInput()

UsdShadeInput(UsdAttribute)

Declaration

public UsdShadeInput(UsdAttribute attr)

Parameters

Type	Name	Description
UsdAttribute	attr

Fields

swigCMemOwn

Declaration

protected bool swigCMemOwn

Field Value

Type	Description
Boolean

Methods

CanConnect(UsdAttribute)

Declaration

public bool CanConnect(UsdAttribute source)

Parameters

Type	Name	Description
UsdAttribute	source

Returns

Type	Description
Boolean

CanConnect(UsdShadeInput)

Declaration

public bool CanConnect(UsdShadeInput sourceInput)

Parameters

Type	Name	Description
UsdShadeInput	sourceInput

Returns

Type	Description
Boolean

CanConnect(UsdShadeOutput)

Declaration

public bool CanConnect(UsdShadeOutput sourceOutput)

Parameters

Type	Name	Description
UsdShadeOutput	sourceOutput

Returns

Type	Description
Boolean

ClearConnectability()

Declaration

public bool ClearConnectability()

Returns

Type	Description
Boolean

ClearSdrMetadata()

Declaration

public void ClearSdrMetadata()

ClearSdrMetadataByKey(TfToken)

Declaration

public void ClearSdrMetadataByKey(TfToken key)

Parameters

Type	Name	Description
TfToken	key

ClearSource()

Declaration

public bool ClearSource()

Returns

Type	Description
Boolean

ConnectToSource(SdfPath)

Declaration

public bool ConnectToSource(SdfPath sourcePath)

Parameters

Type	Name	Description
SdfPath	sourcePath

Returns

Type	Description
Boolean

ConnectToSource(UsdShadeConnectableAPI, TfToken)

Declaration

public bool ConnectToSource(UsdShadeConnectableAPI source, TfToken sourceName)

Parameters

Type	Name	Description
UsdShadeConnectableAPI	source
TfToken	sourceName

Returns

Type	Description
Boolean

ConnectToSource(UsdShadeConnectableAPI, TfToken, UsdShadeAttributeType)

Declaration

public bool ConnectToSource(UsdShadeConnectableAPI source, TfToken sourceName, UsdShadeAttributeType sourceType)

Parameters

Type	Name	Description
UsdShadeConnectableAPI	source
TfToken	sourceName
UsdShadeAttributeType	sourceType

Returns

Type	Description
Boolean

ConnectToSource(UsdShadeConnectableAPI, TfToken, UsdShadeAttributeType, SdfValueTypeName)

Declaration

public bool ConnectToSource(UsdShadeConnectableAPI source, TfToken sourceName, UsdShadeAttributeType sourceType, SdfValueTypeName typeName)

Parameters

Type	Name	Description
UsdShadeConnectableAPI	source
TfToken	sourceName
UsdShadeAttributeType	sourceType
SdfValueTypeName	typeName

Returns

Type	Description
Boolean

ConnectToSource(UsdShadeInput)

Declaration

public bool ConnectToSource(UsdShadeInput sourceInput)

Parameters

Type	Name	Description
UsdShadeInput	sourceInput

Returns

Type	Description
Boolean

ConnectToSource(UsdShadeOutput)

Declaration

public bool ConnectToSource(UsdShadeOutput sourceOutput)

Parameters

Type	Name	Description
UsdShadeOutput	sourceOutput

Returns

Type	Description
Boolean

DisconnectSource()

Declaration

public bool DisconnectSource()

Returns

Type	Description
Boolean

Dispose()

Declaration

public virtual void Dispose()

Implements

IDisposable.Dispose()

Finalize()

Declaration

protected void Finalize()

Get(VtValue)

Declaration

public bool Get(VtValue value)

Parameters

Type	Name	Description
VtValue	value

Returns

Type	Description
Boolean

Get(VtValue, UsdTimeCode)

Declaration

public bool Get(VtValue value, UsdTimeCode time)

Parameters

Type	Name	Description
VtValue	value
UsdTimeCode	time

Returns

Type	Description
Boolean

GetAttr()

Declaration

public UsdAttribute GetAttr()

Returns

Type	Description
UsdAttribute

GetBaseName()

Declaration

public TfToken GetBaseName()

Returns

Type	Description
TfToken

GetConnectability()

Declaration

public TfToken GetConnectability()

Returns

Type	Description
TfToken

GetConnectedSource(UsdShadeConnectableAPI, TfToken, out UsdShadeAttributeType)

Declaration

public bool GetConnectedSource(UsdShadeConnectableAPI source, TfToken sourceName, out UsdShadeAttributeType sourceType)

Parameters

Type	Name	Description
UsdShadeConnectableAPI	source
TfToken	sourceName
UsdShadeAttributeType	sourceType

Returns

Type	Description
Boolean

GetDisplayGroup()

Declaration

public string GetDisplayGroup()

Returns

Type	Description
String

GetDocumentation()

Declaration

public string GetDocumentation()

Returns

Type	Description
String

GetFullName()

Declaration

public TfToken GetFullName()

Returns

Type	Description
TfToken

GetPrim()

Declaration

public UsdPrim GetPrim()

Returns

Type	Description
UsdPrim

GetRawConnectedSourcePaths(SdfPathVector)

Declaration

public bool GetRawConnectedSourcePaths(SdfPathVector sourcePaths)

Parameters

Type	Name	Description
SdfPathVector	sourcePaths

Returns

Type	Description
Boolean

GetRenderType()

Declaration

public TfToken GetRenderType()

Returns

Type	Description
TfToken

GetSdrMetadata()

Declaration

public SWIGTYPE_p_std__unordered_mapT_TfToken_std__string_TfToken__HashFunctor_t GetSdrMetadata()

Returns

Type	Description
SWIGTYPE_p_std__unordered_mapT_TfToken_std__string_TfToken__HashFunctor_t

GetSdrMetadataByKey(TfToken)

Declaration

public string GetSdrMetadataByKey(TfToken key)

Parameters

Type	Name	Description
TfToken	key

Returns

Type	Description
String

GetTypeName()

Declaration

public SdfValueTypeName GetTypeName()

Returns

Type	Description
SdfValueTypeName

GetValueProducingAttribute(SWIGTYPE_p_UsdShadeAttributeType)

Declaration

public UsdAttribute GetValueProducingAttribute(SWIGTYPE_p_UsdShadeAttributeType attrType)

Parameters

Type	Name	Description
SWIGTYPE_p_UsdShadeAttributeType	attrType

Returns

Type	Description
UsdAttribute

HasConnectedSource()

Declaration

public bool HasConnectedSource()

Returns

Type	Description
Boolean

HasRenderType()

Declaration

public bool HasRenderType()

Returns

Type	Description
Boolean

HasSdrMetadata()

Declaration

public bool HasSdrMetadata()

Returns

Type	Description
Boolean

HasSdrMetadataByKey(TfToken)

Declaration

public bool HasSdrMetadataByKey(TfToken key)

Parameters

Type	Name	Description
TfToken	key

Returns

Type	Description
Boolean

IsDefined()

Declaration

public bool IsDefined()

Returns

Type	Description
Boolean

IsInput(UsdAttribute)

Declaration

public static bool IsInput(UsdAttribute attr)

Parameters

Type	Name	Description
UsdAttribute	attr

Returns

Type	Description
Boolean

IsInterfaceInputName(String)

Declaration

public static bool IsInterfaceInputName(string name)

Parameters

Type	Name	Description
String	name

Returns

Type	Description
Boolean

IsSourceConnectionFromBaseMaterial()

Declaration

public bool IsSourceConnectionFromBaseMaterial()

Returns

Type	Description
Boolean

Set(VtValue)

Declaration

public bool Set(VtValue value)

Parameters

Type	Name	Description
VtValue	value

Returns

Type	Description
Boolean

Set(VtValue, UsdTimeCode)

Declaration

public bool Set(VtValue value, UsdTimeCode time)

Parameters

Type	Name	Description
VtValue	value
UsdTimeCode	time

Returns

Type	Description
Boolean

SetConnectability(TfToken)

Declaration

public bool SetConnectability(TfToken connectability)

Parameters

Type	Name	Description
TfToken	connectability

Returns

Type	Description
Boolean

SetDisplayGroup(String)

Declaration

public bool SetDisplayGroup(string displayGroup)

Parameters

Type	Name	Description
String	displayGroup

Returns

Type	Description
Boolean

SetDocumentation(String)

Declaration

public bool SetDocumentation(string docs)

Parameters

Type	Name	Description
String	docs

Returns

Type	Description
Boolean

SetRenderType(TfToken)

Declaration

public bool SetRenderType(TfToken renderType)

Parameters

Type	Name	Description
TfToken	renderType

Returns

Type	Description
Boolean

SetSdrMetadata(SWIGTYPE_p_std__unordered_mapT_TfToken_std__string_TfToken__HashFunctor_t)

Declaration

public void SetSdrMetadata(SWIGTYPE_p_std__unordered_mapT_TfToken_std__string_TfToken__HashFunctor_t sdrMetadata)

Parameters

Type	Name	Description
SWIGTYPE_p_std__unordered_mapT_TfToken_std__string_TfToken__HashFunctor_t	sdrMetadata

SetSdrMetadataByKey(TfToken, String)

Declaration

public void SetSdrMetadataByKey(TfToken key, string value)

Parameters

Type	Name	Description
TfToken	key
String	value