Class UsdShadeConnectableAPI

Inheritance

Object

UsdSchemaBase

UsdAPISchemaBase

UsdShadeConnectableAPI

Inherited Members

UsdSchemaBase.swigCMemOwn

UsdSchemaBase.IsConcrete()

UsdSchemaBase.IsTyped()

UsdSchemaBase.IsAPISchema()

UsdSchemaBase.IsAppliedAPISchema()

UsdSchemaBase.IsMultipleApplyAPISchema()

UsdSchemaBase.GetSchemaType()

UsdSchemaBase.GetPrim()

UsdSchemaBase.GetPath()

UsdSchemaBase.GetSchemaClassPrimDefinition()

UsdSchemaBase.Equals(UsdSchemaBase, UsdSchemaBase)

UsdSchemaBase.GetHashCode()

UsdSchemaBase.Equals(Object)

UsdSchemaBase._IsValid()

Object.ToString()

Object.Equals(Object, Object)

Object.ReferenceEquals(Object, Object)

Object.GetType()

Object.MemberwiseClone()

Namespace: pxr

Syntax

public class UsdShadeConnectableAPI : UsdAPISchemaBase, IDisposable

Constructors

UsdShadeConnectableAPI()

Declaration

public UsdShadeConnectableAPI()

UsdShadeConnectableAPI(UsdPrim)

Declaration

public UsdShadeConnectableAPI(UsdPrim prim)

Parameters

Type	Name	Description
UsdPrim	prim

UsdShadeConnectableAPI(UsdSchemaBase)

Declaration

public UsdShadeConnectableAPI(UsdSchemaBase schemaObj)

Parameters

Type	Name	Description
UsdSchemaBase	schemaObj

UsdShadeConnectableAPI(UsdShadeNodeGraph)

Declaration

public UsdShadeConnectableAPI(UsdShadeNodeGraph nodeGraph)

Parameters

Type	Name	Description
UsdShadeNodeGraph	nodeGraph

UsdShadeConnectableAPI(UsdShadeShader)

Declaration

public UsdShadeConnectableAPI(UsdShadeShader shader)

Parameters

Type	Name	Description
UsdShadeShader	shader

Methods

CanConnect(UsdShadeInput, UsdAttribute)

Declaration

public static bool CanConnect(UsdShadeInput input, UsdAttribute source)

Parameters

Type	Name	Description
UsdShadeInput	input
UsdAttribute	source

Returns

Type	Description
Boolean

CanConnect(UsdShadeInput, UsdShadeInput)

Declaration

public static bool CanConnect(UsdShadeInput input, UsdShadeInput sourceInput)

Parameters

Type	Name	Description
UsdShadeInput	input
UsdShadeInput	sourceInput

Returns

Type	Description
Boolean

CanConnect(UsdShadeInput, UsdShadeOutput)

Declaration

public static bool CanConnect(UsdShadeInput input, UsdShadeOutput sourceOutput)

Parameters

Type	Name	Description
UsdShadeInput	input
UsdShadeOutput	sourceOutput

Returns

Type	Description
Boolean

CanConnect(UsdShadeOutput)

Declaration

public static bool CanConnect(UsdShadeOutput output)

Parameters

Type	Name	Description
UsdShadeOutput	output

Returns

Type	Description
Boolean

CanConnect(UsdShadeOutput, UsdAttribute)

Declaration

public static bool CanConnect(UsdShadeOutput output, UsdAttribute source)

Parameters

Type	Name	Description
UsdShadeOutput	output
UsdAttribute	source

Returns

Type	Description
Boolean

CanConnect(UsdShadeOutput, UsdShadeInput)

Declaration

public static bool CanConnect(UsdShadeOutput output, UsdShadeInput sourceInput)

Parameters

Type	Name	Description
UsdShadeOutput	output
UsdShadeInput	sourceInput

Returns

Type	Description
Boolean

CanConnect(UsdShadeOutput, UsdShadeOutput)

Declaration

public static bool CanConnect(UsdShadeOutput output, UsdShadeOutput sourceOutput)

Parameters

Type	Name	Description
UsdShadeOutput	output
UsdShadeOutput	sourceOutput

Returns

Type	Description
Boolean

ClearSource(UsdAttribute)

Declaration

public static bool ClearSource(UsdAttribute shadingAttr)

Parameters

Type	Name	Description
UsdAttribute	shadingAttr

Returns

Type	Description
Boolean

ClearSource(UsdShadeInput)

Declaration

public static bool ClearSource(UsdShadeInput input)

Parameters

Type	Name	Description
UsdShadeInput	input

Returns

Type	Description
Boolean

ClearSource(UsdShadeOutput)

Declaration

public static bool ClearSource(UsdShadeOutput output)

Parameters

Type	Name	Description
UsdShadeOutput	output

Returns

Type	Description
Boolean

ConnectToSource(UsdAttribute, SdfPath)

Declaration

public static bool ConnectToSource(UsdAttribute shadingAttr, SdfPath sourcePath)

Parameters

Type	Name	Description
UsdAttribute	shadingAttr
SdfPath	sourcePath

Returns

Type	Description
Boolean

ConnectToSource(UsdAttribute, UsdShadeConnectableAPI, TfToken)

Declaration

public static bool ConnectToSource(UsdAttribute shadingAttr, UsdShadeConnectableAPI source, TfToken sourceName)

Parameters

Type	Name	Description
UsdAttribute	shadingAttr
UsdShadeConnectableAPI	source
TfToken	sourceName

Returns

Type	Description
Boolean

ConnectToSource(UsdAttribute, UsdShadeConnectableAPI, TfToken, UsdShadeAttributeType)

Declaration

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

Parameters

Type	Name	Description
UsdAttribute	shadingAttr
UsdShadeConnectableAPI	source
TfToken	sourceName
UsdShadeAttributeType	sourceType

Returns

Type	Description
Boolean

ConnectToSource(UsdAttribute, UsdShadeConnectableAPI, TfToken, UsdShadeAttributeType, SdfValueTypeName)

Declaration

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

Parameters

Type	Name	Description
UsdAttribute	shadingAttr
UsdShadeConnectableAPI	source
TfToken	sourceName
UsdShadeAttributeType	sourceType
SdfValueTypeName	typeName

Returns

Type	Description
Boolean

ConnectToSource(UsdAttribute, UsdShadeInput)

Declaration

public static bool ConnectToSource(UsdAttribute shadingAttr, UsdShadeInput sourceInput)

Parameters

Type	Name	Description
UsdAttribute	shadingAttr
UsdShadeInput	sourceInput

Returns

Type	Description
Boolean

ConnectToSource(UsdAttribute, UsdShadeOutput)

Declaration

public static bool ConnectToSource(UsdAttribute shadingAttr, UsdShadeOutput sourceOutput)

Parameters

Type	Name	Description
UsdAttribute	shadingAttr
UsdShadeOutput	sourceOutput

Returns

Type	Description
Boolean

ConnectToSource(UsdShadeInput, SdfPath)

Declaration

public static bool ConnectToSource(UsdShadeInput input, SdfPath sourcePath)

Parameters

Type	Name	Description
UsdShadeInput	input
SdfPath	sourcePath

Returns

Type	Description
Boolean

ConnectToSource(UsdShadeInput, UsdShadeConnectableAPI, TfToken)

Declaration

public static bool ConnectToSource(UsdShadeInput input, UsdShadeConnectableAPI source, TfToken sourceName)

Parameters

Type	Name	Description
UsdShadeInput	input
UsdShadeConnectableAPI	source
TfToken	sourceName

Returns

Type	Description
Boolean

ConnectToSource(UsdShadeInput, UsdShadeConnectableAPI, TfToken, UsdShadeAttributeType)

Declaration

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

Parameters

Type	Name	Description
UsdShadeInput	input
UsdShadeConnectableAPI	source
TfToken	sourceName
UsdShadeAttributeType	sourceType

Returns

Type	Description
Boolean

ConnectToSource(UsdShadeInput, UsdShadeConnectableAPI, TfToken, UsdShadeAttributeType, SdfValueTypeName)

Declaration

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

Parameters

Type	Name	Description
UsdShadeInput	input
UsdShadeConnectableAPI	source
TfToken	sourceName
UsdShadeAttributeType	sourceType
SdfValueTypeName	typeName

Returns

Type	Description
Boolean

ConnectToSource(UsdShadeInput, UsdShadeInput)

Declaration

public static bool ConnectToSource(UsdShadeInput input, UsdShadeInput sourceInput)

Parameters

Type	Name	Description
UsdShadeInput	input
UsdShadeInput	sourceInput

Returns

Type	Description
Boolean

ConnectToSource(UsdShadeInput, UsdShadeOutput)

Declaration

public static bool ConnectToSource(UsdShadeInput input, UsdShadeOutput sourceOutput)

Parameters

Type	Name	Description
UsdShadeInput	input
UsdShadeOutput	sourceOutput

Returns

Type	Description
Boolean

ConnectToSource(UsdShadeOutput, SdfPath)

Declaration

public static bool ConnectToSource(UsdShadeOutput output, SdfPath sourcePath)

Parameters

Type	Name	Description
UsdShadeOutput	output
SdfPath	sourcePath

Returns

Type	Description
Boolean

ConnectToSource(UsdShadeOutput, UsdShadeConnectableAPI, TfToken)

Declaration

public static bool ConnectToSource(UsdShadeOutput output, UsdShadeConnectableAPI source, TfToken sourceName)

Parameters

Type	Name	Description
UsdShadeOutput	output
UsdShadeConnectableAPI	source
TfToken	sourceName

Returns

Type	Description
Boolean

ConnectToSource(UsdShadeOutput, UsdShadeConnectableAPI, TfToken, UsdShadeAttributeType)

Declaration

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

Parameters

Type	Name	Description
UsdShadeOutput	output
UsdShadeConnectableAPI	source
TfToken	sourceName
UsdShadeAttributeType	sourceType

Returns

Type	Description
Boolean

ConnectToSource(UsdShadeOutput, UsdShadeConnectableAPI, TfToken, UsdShadeAttributeType, SdfValueTypeName)

Declaration

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

Parameters

Type	Name	Description
UsdShadeOutput	output
UsdShadeConnectableAPI	source
TfToken	sourceName
UsdShadeAttributeType	sourceType
SdfValueTypeName	typeName

Returns

Type	Description
Boolean

ConnectToSource(UsdShadeOutput, UsdShadeInput)

Declaration

public static bool ConnectToSource(UsdShadeOutput output, UsdShadeInput sourceInput)

Parameters

Type	Name	Description
UsdShadeOutput	output
UsdShadeInput	sourceInput

Returns

Type	Description
Boolean

ConnectToSource(UsdShadeOutput, UsdShadeOutput)

Declaration

public static bool ConnectToSource(UsdShadeOutput output, UsdShadeOutput sourceOutput)

Parameters

Type	Name	Description
UsdShadeOutput	output
UsdShadeOutput	sourceOutput

Returns

Type	Description
Boolean

CreateInput(TfToken, SdfValueTypeName)

Declaration

public UsdShadeInput CreateInput(TfToken name, SdfValueTypeName typeName)

Parameters

Type	Name	Description
TfToken	name
SdfValueTypeName	typeName

Returns

Type	Description
UsdShadeInput

CreateOutput(TfToken, SdfValueTypeName)

Declaration

public UsdShadeOutput CreateOutput(TfToken name, SdfValueTypeName typeName)

Parameters

Type	Name	Description
TfToken	name
SdfValueTypeName	typeName

Returns

Type	Description
UsdShadeOutput

DisconnectSource(UsdAttribute)

Declaration

public static bool DisconnectSource(UsdAttribute shadingAttr)

Parameters

Type	Name	Description
UsdAttribute	shadingAttr

Returns

Type	Description
Boolean

DisconnectSource(UsdShadeInput)

Declaration

public static bool DisconnectSource(UsdShadeInput input)

Parameters

Type	Name	Description
UsdShadeInput	input

Returns

Type	Description
Boolean

DisconnectSource(UsdShadeOutput)

Declaration

public static bool DisconnectSource(UsdShadeOutput output)

Parameters

Type	Name	Description
UsdShadeOutput	output

Returns

Type	Description
Boolean

Dispose()

Declaration

public override void Dispose()

Overrides

UsdAPISchemaBase.Dispose()

Finalize()

Declaration

protected void Finalize()

Get(UsdStageWeakPtr, SdfPath)

Declaration

public static UsdShadeConnectableAPI Get(UsdStageWeakPtr stage, SdfPath path)

Parameters

Type	Name	Description
UsdStageWeakPtr	stage
SdfPath	path

Returns

Type	Description
UsdShadeConnectableAPI

GetConnectedSource(UsdAttribute, UsdShadeConnectableAPI, TfToken, out UsdShadeAttributeType)

Declaration

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

Parameters

Type	Name	Description
UsdAttribute	shadingAttr
UsdShadeConnectableAPI	source
TfToken	sourceName
UsdShadeAttributeType	sourceType

Returns

Type	Description
Boolean

GetConnectedSource(UsdShadeInput, UsdShadeConnectableAPI, TfToken, out UsdShadeAttributeType)

Declaration

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

Parameters

Type	Name	Description
UsdShadeInput	input
UsdShadeConnectableAPI	source
TfToken	sourceName
UsdShadeAttributeType	sourceType

Returns

Type	Description
Boolean

GetConnectedSource(UsdShadeOutput, UsdShadeConnectableAPI, TfToken, out UsdShadeAttributeType)

Declaration

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

Parameters

Type	Name	Description
UsdShadeOutput	output
UsdShadeConnectableAPI	source
TfToken	sourceName
UsdShadeAttributeType	sourceType

Returns

Type	Description
Boolean

GetInput(TfToken)

Declaration

public UsdShadeInput GetInput(TfToken name)

Parameters

Type	Name	Description
TfToken	name

Returns

Type	Description
UsdShadeInput

GetInputs()

Declaration

public UsdShadeInputVector GetInputs()

Returns

Type	Description
UsdShadeInputVector

GetOutput(TfToken)

Declaration

public UsdShadeOutput GetOutput(TfToken name)

Parameters

Type	Name	Description
TfToken	name

Returns

Type	Description
UsdShadeOutput

GetOutputs()

Declaration

public UsdShadeOutputVector GetOutputs()

Returns

Type	Description
UsdShadeOutputVector

GetRawConnectedSourcePaths(UsdAttribute, SdfPathVector)

Declaration

public static bool GetRawConnectedSourcePaths(UsdAttribute shadingAttr, SdfPathVector sourcePaths)

Parameters

Type	Name	Description
UsdAttribute	shadingAttr
SdfPathVector	sourcePaths

Returns

Type	Description
Boolean

GetRawConnectedSourcePaths(UsdShadeInput, SdfPathVector)

Declaration

public static bool GetRawConnectedSourcePaths(UsdShadeInput input, SdfPathVector sourcePaths)

Parameters

Type	Name	Description
UsdShadeInput	input
SdfPathVector	sourcePaths

Returns

Type	Description
Boolean

GetRawConnectedSourcePaths(UsdShadeOutput, SdfPathVector)

Declaration

public static bool GetRawConnectedSourcePaths(UsdShadeOutput output, SdfPathVector sourcePaths)

Parameters

Type	Name	Description
UsdShadeOutput	output
SdfPathVector	sourcePaths

Returns

Type	Description
Boolean

GetSchemaAttributeNames()

Declaration

public static TfTokenVector GetSchemaAttributeNames()

Returns

Type	Description
TfTokenVector

GetSchemaAttributeNames(Boolean)

Declaration

public static TfTokenVector GetSchemaAttributeNames(bool includeInherited)

Parameters

Type	Name	Description
Boolean	includeInherited

Returns

Type	Description
TfTokenVector

HasConnectedSource(UsdAttribute)

Declaration

public static bool HasConnectedSource(UsdAttribute shadingAttr)

Parameters

Type	Name	Description
UsdAttribute	shadingAttr

Returns

Type	Description
Boolean

HasConnectedSource(UsdShadeInput)

Declaration

public static bool HasConnectedSource(UsdShadeInput input)

Parameters

Type	Name	Description
UsdShadeInput	input

Returns

Type	Description
Boolean

HasConnectedSource(UsdShadeOutput)

Declaration

public static bool HasConnectedSource(UsdShadeOutput output)

Parameters

Type	Name	Description
UsdShadeOutput	output

Returns

Type	Description
Boolean

IsNodeGraph()

Declaration

public bool IsNodeGraph()

Returns

Type	Description
Boolean

IsShader()

Declaration

public bool IsShader()

Returns

Type	Description
Boolean

IsSourceConnectionFromBaseMaterial(UsdAttribute)

Declaration

public static bool IsSourceConnectionFromBaseMaterial(UsdAttribute shadingAttr)

Parameters

Type	Name	Description
UsdAttribute	shadingAttr

Returns

Type	Description
Boolean

IsSourceConnectionFromBaseMaterial(UsdShadeInput)

Declaration

public static bool IsSourceConnectionFromBaseMaterial(UsdShadeInput input)

Parameters

Type	Name	Description
UsdShadeInput	input

Returns

Type	Description
Boolean

IsSourceConnectionFromBaseMaterial(UsdShadeOutput)

Declaration

public static bool IsSourceConnectionFromBaseMaterial(UsdShadeOutput output)

Parameters

Type	Name	Description
UsdShadeOutput	output

Returns

Type	Description
Boolean