Class InteractiveClippingPlane

Interactive clipping plane object which can be added to the scene. This class exposes properties of C++ class Graphic3d_ClipPlane defined by OCCT.

Hierarchy (View Summary)

Constructors

constructor

Properties

_myObjId _myViewer

Accessors

bndBox clipPlaneSequence color id isAutoUpdateBbox isCapping isExist isInteractive isLoaded isRelative isVisualizationOnly maxAxisPosition minAxisPosition normal objects offset origin selectable sliceCount sliceNb sliceSize transparency visible visibleInView zLayer

Methods

_clone clone remove setPlaneSequence setPlaneSequenceIds updateBoundingBox

Constructors

constructor

Properties

Protected_myObjId

_myObjId: string

Protected_myViewer

_myViewer: OccViewer

Accessors

bndBox

  • get bndBox(): BndBox

  • Get bounding box.

    Returns BndBox

clipPlaneSequence

  • get clipPlaneSequence(): string

  • Get the list of clipping plane sequence ids.

    Returns string

  • set clipPlaneSequence(thePlaneSequenceIds: string): void

  • Set the clipping plane sequence ids with logical and (conjunction) applied to the sequence of clipping planes.

    Parameters

    • thePlaneSequenceIds: string

    Returns void

color

  • get color(): string

  • Return object's global RGB color defined as OccViewer.ColorString

    Returns string

  • set color(theColor: string): void

  • Set object's global color or empty string to unset.

    Parameters

    • theColor: string

    Returns void

id

  • get id(): string

  • Get object id as string.

    Returns string

isAutoUpdateBbox

  • get isAutoUpdateBbox(): boolean

  • Get the auto update bounding box state.

    Returns boolean

  • set isAutoUpdateBbox(theIsAutoUpdateBbox: boolean): void

  • Set the auto update bounding box state.

    Parameters

    • theIsAutoUpdateBbox: boolean

    Returns void

isCapping

  • get isCapping(): boolean

  • Get or set the capping enabled/disabled state of the clipping plane.

    Returns boolean

  • set isCapping(theIsCapping: boolean): void

  • Parameters

    • theIsCapping: boolean

    Returns void

isExist

  • get isExist(): boolean

  • Return TRUE if object with specified Id exists.

    Returns boolean

isInteractive

  • get isInteractive(): boolean

  • Get or set the clipping plane interactivity state.

    Returns boolean

  • set isInteractive(theIsInteractive: boolean): void

  • Parameters

    • theIsInteractive: boolean

    Returns void

isLoaded

  • get isLoaded(): boolean

  • Return TRUE if object with specified Id has deferred data loaded.

    Returns boolean

isRelative

  • get isRelative(): boolean

  • Get or set the flag that signals whether the origin depends on AABB size of selected objects.

    Returns boolean

  • set isRelative(theIsRelative: boolean): void

  • Parameters

    • theIsRelative: boolean

    Returns void

isVisualizationOnly

  • get isVisualizationOnly(): boolean

  • Get or set the visualization only enabled/disabled state of the clipping plane.

    Returns boolean

  • set isVisualizationOnly(theIsVisualizationOnly: boolean): void

  • Parameters

    • theIsVisualizationOnly: boolean

    Returns void

maxAxisPosition

  • get maxAxisPosition(): number

  • Get the maximum clipping plane position coordinate on the plane axis.

    Returns number

minAxisPosition

  • get minAxisPosition(): number

  • Get the minimum clipping plane position coordinate on the plane axis.

    Returns number

normal

objects

  • get objects(): string

  • Get or set the objects that the clipping plane applies to.

    Returns string

  • set objects(theObjects: string): void

  • Parameters

    • theObjects: string

    Returns void

offset

  • get offset(): number

  • Get or set the offset of the clipping plane on the plane axis.

    Returns number

  • set offset(theOffset: number): void

  • Parameters

    • theOffset: number

    Returns void

origin

selectable

  • get selectable(): boolean

  • Return object's selectable status.

    Returns boolean

  • set selectable(theIsSelectable: boolean): void

  • Set object's selectable status.

    Parameters

    • theIsSelectable: boolean

    Returns void

sliceCount

  • get sliceCount(): number

  • Get the number of slices.

    Returns number

sliceNb

  • get sliceNb(): number

  • Get the current slice number.

    Returns number

  • set sliceNb(theSliceNumber: number): void

  • Set the current slice number.

    Parameters

    • theSliceNumber: number

    Returns void

sliceSize

  • get sliceSize(): number

  • Get the slice portion size.

    Returns number

  • set sliceSize(theSliceSize: number): void

  • Set the slice portion size.

    Parameters

    • theSliceSize: number

    Returns void

transparency

  • get transparency(): number

  • Return object's transparency within [0.0, 1.0] range, or 0.0 if unspecified.

    Returns number

  • set transparency(theTransp: number): void

  • Set object's global transparency within [0.0, 1.0] range, or 0.0 to unset.

    Parameters

    • theTransp: number

    Returns void

visible

  • get visible(): boolean

  • Get or set the clipping plane enabled state.

    Returns boolean

  • set visible(theIsEnabled: boolean): void

  • Return object visibility state.

    Parameters

    • theIsEnabled: boolean

    Returns void

visibleInView

  • get visibleInView(): null | Subview

  • Return view in which object is visible or NULL if it is not displayed or displayed in multiple views.

    Returns null | Subview

  • set visibleInView(theView: null | Subview): void

  • Set object to be visible only within specific view or all views (NULL) - view affinity. Note that visible still has to be set independently.

    Parameters

    Returns void

zLayer

  • get zLayer(): ZLayerId

  • Return z layer of object.

    Returns ZLayerId

  • set zLayer(theLayer: ZLayerId): void

  • Set z layer of object.

    Parameters

    Returns void

Methods

Protected_clone

clone

remove

setPlaneSequence

  • setPlaneSequence(...thePlaneSequence: InteractiveClippingPlane[]): void

  • Set the clipping plane sequence ids with logical and (conjunction) applied to the sequence of clipping planes.

    Parameters

    Returns void

setPlaneSequenceIds

  • setPlaneSequenceIds(
        theAndPlaneSequence: string,
        theOrPlaneSequence: string,
    ): void

  • Set of clipping planes.

    Parameters

    • theAndPlaneSequence: string
    • theOrPlaneSequence: string

    Returns void

updateBoundingBox

  • updateBoundingBox(): void

  • Update bounding box

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods