Class Shape

A shape is an object that uses mathematical and vector descriptions to be drawn. It can, theoretically, be scaled indefinitely.

Shapes can be rendered to a texture. The Shape object holds the list of all commands that need to be executed by the system to render the shape. You can submit a shape for rendering using it's method.

Hierarchy (view full)

Constructors

constructor

Accessors

bounds center handle hash isDestroyed metaData name origin path paths size uuid

Methods

duplicate isEqualTo onCreate onDeserializationEnded onDisable onEnable onInitialize onSerializationStart revert unload

Constructors

constructor

  • new Shape(pathOrSvgFileContents, isInternalConstructor?): Shape

  • Creates a new Shape from an existing path.

    Parameters

    • pathOrSvgFileContents: string | Path

      The parameter to the call.

    • OptionalisInternalConstructor: boolean

    Returns Shape

Accessors

bounds

center

handle

hash

  • get hash(): number

  • Gets the shape hash. Useful to check if two shapes are equal.

    Returns number

isDestroyed

  • get isDestroyed(): boolean

  • Determines if the resource is destroyed.

    Returns boolean

    Note

    This can happen when the Resource was forcefully unloaded or reverted. For this reason, it is safer to hold on to a instead of directly referencing a resource pointer, as the current Resource can always be retrieved via .value.

metaData

name

  • get name(): string

  • Name of the resource. Use primarily for easier identification and not important to the engine itself.

    Returns string

origin

path

  • get path(): Path

  • The shape path.

    Returns Path

paths

size

uuid

  • get uuid(): UUID

  • Returns a universally unique identifier of this resource.

    Returns UUID

Methods

duplicate

  • duplicate(): Resource

  • Duplicates the resource and creates a unique UUID for the duplicated resource.

    Returns Resource

    The duplicated resource or null, if the duplication failed.

isEqualTo

  • isEqualTo(shape): boolean

  • Compares two shapes to check for equality.

    Parameters

    Returns boolean

onCreate

  • onCreate(): void
  • Virtual

    Method called by RSX to perform actions required after the creation of the resource.

    Returns void

onDeserializationEnded

  • onDeserializationEnded(): void
  • Virtual

    Method called by RSX to perform any operations needed after deserialization.

    Returns void

    Note

    Use this API to restore your serializable data into live objects.

onDisable

  • onDisable(): void
  • Virtual

    Method called by RSX to disable the resource.

    Returns void

    Note

    Use this API to deactivate the resource before it is serialized.

onEnable

  • onEnable(): void
  • Virtual

    Method called by RSX to enable the resource.

    Returns void

    Note

    Use this API to activate the resource after it has been disabled by serialization.

onInitialize

  • onInitialize(): void
  • Virtual

    Method called by RSX to perform initialization of the resource.

    Returns void

    Note

    Use this API to initialize data and default construct all fields.

onSerializationStart

  • onSerializationStart(): void
  • Virtual

    Method called by RSX to perform any operations before serialization.

    Returns void

    Note

    Use this API to bake your live data into serializable data.

revert

  • revert(): boolean

  • Reverts the resource to the on-disk representation.

    Returns boolean

    Note

    This is a potentially expensive call, as it needs to deserialize and replace all existing in-memory resource handles.

unload

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods