Class GraphType

The GraphType represents a type inside the graph used to specify the type of a GraphPin or the type specialization of a TemplatedGraphNode.

The GraphType system is able to uniquely mangle types as well as perform type remapping based on the proxyType setting of the GraphObjectAttribute.

Index

Properties

name systemType

Accessors

friendlyName isCompound primaryType registeredTypeCount remappedGraphTypes

Methods

isSubclassOf isSubclassOfAny get iterateTypesMatching

Properties

`Readonly`name

name: string

The name of the type.

`Readonly`systemType

systemType: Type[]

The underlying system type.

Accessors

friendlyName

get friendlyName(): string

The friendly name of the type. Use for display in the UI.

Returns string

isCompound

get isCompound(): boolean

Determines if this instance is a compound type, such as a ResourceHandle of a specified type such as Mesh.

Returns boolean

Note
Compound types are represented within RSX's type system as an array e.g. [ResourceHandle, Mesh].

primaryType

get primaryType(): Type

Gets the primary type of this instance.

Returns Type

`Static`registeredTypeCount

get registeredTypeCount(): number

The number of registered types.

Returns number

`Static`remappedGraphTypes

get remappedGraphTypes(): Map<Type, Type>

Gets a map of all type that are remapped to other types through the proxyType GraphObjectAttribute.

Returns Map<Type, Type>

Methods

isSubclassOf

isSubclassOf(type: Type | GraphType): boolean
Determines if this instance is a subclass of type.
Parameters
- type: Type | GraphType
Returns boolean

isSubclassOfAny

isSubclassOfAny(...types: (Type | GraphType)[]): boolean
Determines if this instance is a subclass of any of the specifies types.
Parameters
- ...types: (Type | GraphType)[]
Returns boolean

`Static`get

get(type: Type | Type[]): any
Gets the corresponding GraphType for the specified Type or compound type.
Parameters
- type: Type | Type[]
Returns any

`Static`iterateTypesMatching

iterateTypesMatching(
query: string,
compatibility?: Set<GraphCompatibiltyName>,
): Generator<GraphType>
Finds all types that contain the search query.
Parameters
- query: string
- Optionalcompatibility: Set<GraphCompatibiltyName>
Returns Generator<GraphType>