Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ModelMemento

Saves and restores a snapshot of the visual state of the Entity's of a model within a Scene.

Hierarchy

  • ModelMemento

Index

Constructors

Methods

Constructors

constructor

Methods

restoreObjects

  • Restores a Scene's Entity's to their state previously captured with {@link ModelMemento#saveObjects}.

    Assumes that the model has not been destroyed or modified since saving.

    Parameters

    • scene: Scene

      The scene that was given to {@link ModelMemento#saveObjects}.

    • metaModel: MetaModel

      The metamodel that was given to {@link ModelMemento#saveObjects}.

    Returns void

saveObjects

  • saveObjects(scene: Scene, metaModel: MetaModel, mask?: { clippable?: boolean; colorize?: boolean; edges?: boolean; highlighted?: boolean; opacity?: boolean; pickable?: boolean; selected?: boolean; visible?: boolean; xrayed?: boolean }): void

  • Saves a snapshot of the visual state of the Entity's that represent objects within a model.

    Parameters

    • scene: Scene

      The scene.

    • metaModel: MetaModel

      Represents the model. Corresponds with an Entity that represents the model in the scene.

    • Optional mask: { clippable?: boolean; colorize?: boolean; edges?: boolean; highlighted?: boolean; opacity?: boolean; pickable?: boolean; selected?: boolean; visible?: boolean; xrayed?: boolean }
      • Optional clippable?: boolean
      • Optional colorize?: boolean
      • Optional edges?: boolean
      • Optional highlighted?: boolean
      • Optional opacity?: boolean
      • Optional pickable?: boolean
      • Optional selected?: boolean
      • Optional visible?: boolean
      • Optional xrayed?: boolean

    Returns void

Generated using TypeDoc