W-CF Documentation - v11.0.0
    Preparing search index...

    Class SubArticleElement

    Hierarchy (View Summary)

    Index
    eventAdded: ListenableEvent<void, SceneElement> = ...
    eventBoundingBoxChanged: ListenableEvent<void, SceneElement> = ...

    Should be triggered if the list of properties, the value or the state (visible, editable) of one or more properties has changed.

    eventRemoved: ListenableEvent<void, SceneElement> = ...
    eventTransformationChanged: ListenableEvent<void, SceneElement> = ...
    mBasketId: string | null
    mModel: ModelManager
    mNode: TransformNode
    mOapInteractors: Interactors
    mRecoveryBasketId: string
    • get basketId(): string | null

      BasketId may be null if the article is not intantiated yes (use ensureIsInstanced()). e.g. if article is a newly created clone

      Returns string | null

    • get boundingBox(): BoundingBox

      Complete bounding box of this element inluding invisible nodes.

      Returns BoundingBox

    • get boundingBoxVisible(): BoundingBox

      Bounding box of this element inluding only visible elements.

      Returns BoundingBox

    • get hasGeometry(): boolean

      Returns false if the article (including its children) has no or an empty geometry.

      Returns boolean

    • get isDisposed(): boolean

      Returns boolean

    • get isHidden(): boolean

      If true this element and all its children will not be visible.

      Returns boolean

    • get isSelected(): boolean

      Returns boolean

    • get node(): TransformNode

      Returns TransformNode

    • get transform(): Matrix

      Returns Matrix

    • get transformInverted(): Matrix

      Returns Matrix

    • get worldTransform(): Matrix

      Returns Matrix

    • get worldTransformInverted(): Matrix

      Returns Matrix

    • Should be called if the element was removed from the scene and will never be used again.

      Returns void

    • Retrieves the article data for this article. In order to retrieve the properties, the article has to be instantiated on server side. This may not be possible if the ofml data is not installed or it has changed (article requires migration). The operation would fail in those cases. If properties are not required the noProperties option can be set to true to avoid this. (Default: false)

      Parameters

      Returns Promise<ArticleData>

    • Parameters

      • pIncludeChildElementNodes: boolean

      Returns TransformNode[]

    • Returns true if this article has interactors. E.g. OAP interactors.

      Returns Promise<boolean>

    • Can be overridden to disable the default selection highlight for this element. (Default: true)

      Returns boolean

    • Will be called for certain operations to load the undo data which was saved with a previous saveUndoData() call.

      Parameters

      Returns void

    • Parameters

      • pFlags: number
      • pNotifyParent: boolean = true

      Returns void

    • Parameters

      • pNewNode: TransformNode
      • pKeepTransfom: boolean
      • pKeepParent: boolean
      • pNotifyParent: boolean = true

      Returns void

    • Can be used to provide additional undo related data for certain operations. Will be called before the operation is performed.

      Parameters

      Returns object | null

    • If hidden this element and all its children will not be visible. The hidden state of an element is persistent.

      Parameters

      • pHidden: boolean

      Returns void

    • Parameters

      • pNode: TransformNode

      Returns void

    • Parameters

      • pTransform: Matrix

      Returns boolean

    • Should be called after the transformation of this.node was modified directly instead of using this.setTransform(). This function updates frozen world matrices and calls notifyChange with ElementChangedFlags.Transformation.

      Parameters

      • pUpdateChildNodes: boolean = true

      Returns void

    • Parameters

      • pNode: TransformNode
      • OptionalpNewParent: TransformNode | null
      • OptionalpChildNodes: boolean

      Returns TransformNode