Hierarchy

  • ExtensionProperty<any>
    • GenericExtensionProperty

Constructors

Properties

[$attributes]: GraphNodeAttributesInternal<GenericExtensionProperty, any>

Attributes (literal values and GraphNode references) associated with this instance. For each GraphNode reference, the attributes stores a GraphEdge. List and Map references are stored as arrays and dictionaries of edges.

[$immutableKeys]: Set<string>

Attributes included with getDefaultAttributes are considered immutable, and cannot be modifed by .setRef(), .copy(), or other GraphNode methods. Both the edges and the properties will be disposed with the parent GraphNode.

Currently, only single-edge references (getRef/setRef) are supported as immutables.

extensionName: string
parentTypes: string[] = ...
propertyType: string = 'GenericExtension'
textures: Record<string, [TextureInfo, null | Texture]> = {}
EXTENSION_NAME: string

Methods

  • Parameters

    • type: string
    • listener: EventListener<GraphNodeEvent>

    Returns GenericExtensionProperty

  • Parameters

    • key: string
    • texInfo: TextureInfo
    • texture: null | Texture
    • channels: number = 0x1111

    Returns void

  • Makes a copy of this property, with the same resources (by reference) as the original.

    Returns GenericExtensionProperty

  • Copies all data from another property to this one. Child properties are copied by reference, unless a 'resolve' function is given to override that.

    Parameters

    • other: GenericExtensionProperty

      Property to copy references from.

    • Optional resolve: PropertyResolver<Property<IProperty>>

      Function to resolve each Property being transferred. Default is identity.

    Returns GenericExtensionProperty

  • Returns true if two properties are deeply equivalent, recursively comparing the attributes of the properties. Optionally, a 'skip' set may be included, specifying attributes whose values should not be considered in the comparison.

    Example: Two Primitive Primitives are equivalent if they have accessors and materials with equivalent content — but not necessarily the same specific accessors and materials.

    Parameters

    Returns boolean

  • Returns default attributes for the property. Empty lists and maps should be initialized to empty arrays and objects. Always invoke super.getDefaults() and extend the result.

    Returns Nullable<any>

  • Returns a reference to the Extras object, containing application-specific data for this Property. Extras should be an Object, not a primitive value, for best portability.

    Returns Record<string, unknown>

  • Returns the name of this property. While names are not required to be unique, this is encouraged, and non-unique names will be overwritten in some tools. For custom data about a property, prefer to use Extras.

    Returns string

  • Returns true if the node has been permanently removed from the graph.

    Returns boolean

  • Internal

    Returns true if two nodes are on the same Graph.

    Parameters

    • other: GraphNode<{}>

    Returns boolean

  • Returns a list of all properties that hold a reference to this property. For example, a material may hold references to various textures, but a texture does not hold references to the materials that use it.

    It is often necessary to filter the results for a particular type: some resources, like Accessors, may be referenced by different types of properties. Most properties include the Root as a parent, which is usually not of interest.

    Usage:

    const materials = texture
    .listParents()
    .filter((p) => p instanceof Material)

    Returns Property<IProperty>[]

  • Parameters

    • type: string
    • listener: EventListener<GraphNodeEvent>

    Returns GenericExtensionProperty

  • Updates the Extras object, containing application-specific data for this Property. Extras should be an Object, not a primitive value, for best portability.

    Parameters

    • extras: Record<string, unknown>

    Returns GenericExtensionProperty

  • Sets the name of this property. While names are not required to be unique, this is encouraged, and non-unique names will be overwritten in some tools. For custom data about a property, prefer to use Extras.

    Parameters

    • name: string

    Returns GenericExtensionProperty

Generated using TypeDoc