Interface ClippingPlane

Clipping plane controller is a global object accessible via OccViewer.ClippingPlane, responsible for managing clipping parameters.

This class exposes properties of C++ class Graphic3d_ClipPlane defined by OCCT.

interface ClippingPlane {
    clipPlaneSequence: string;
    id: string;
    isAutoUpdateBbox: boolean;
    isCapping: boolean;
    isEnabled: boolean;
    isInteractive: boolean;
    isRelative: boolean;
    isVisualizationOnly: boolean;
    maxAxisPosition: number;
    minAxisPosition: number;
    normal: WasmVector3d;
    objects: string;
    offset: number;
    origin: WasmVector3d;
    setClipPlaneSequence: (
        thePlaneSequenceIds: string,
        theOrPlaneSequence: string,
    ) => void;
    sliceCount: number;
    sliceNb: number;
    sliceSize: number;
    updateBoundingBox: () => void;
}

Properties

clipPlaneSequence id isAutoUpdateBbox isCapping isEnabled isInteractive isRelative isVisualizationOnly maxAxisPosition minAxisPosition normal objects offset origin setClipPlaneSequence sliceCount sliceNb sliceSize updateBoundingBox

Properties

ReadonlyclipPlaneSequence

clipPlaneSequence: string

Get the list of clipping plane sequence ids.

id

id: string

Id of current clipping plane

isAutoUpdateBbox

isAutoUpdateBbox: boolean

isAutoUpdateBbox

isCapping

isCapping: boolean

Capping enabled/disabled state.

isEnabled

isEnabled: boolean

Clipping plane enabled state.

isInteractive

isInteractive: boolean

Clipping plane interactivity state.

isRelative

isRelative: boolean

Flag signals that origin will depend on AABB size of selected objects e.g (0..1)->(mincorner..maxcorner).

isVisualizationOnly

isVisualizationOnly: boolean

Clipping plane is displayed with the clipping option disabled.

ReadonlymaxAxisPosition

maxAxisPosition: number

Maximum clipping plane position coordinate on the plane axis.

ReadonlyminAxisPosition

minAxisPosition: number

Minimum clipping plane position coordinate on the plane axis.

normal

normal: WasmVector3d

Normal of plane.

objects

objects: string

Apply plane to.

  • '*' all displayed model objects;
  • '' all graphical objects (including ground);
  • objects starting with specified id.

offset

offset: number

Offset of clipping plane on the plane axis.

origin

origin: WasmVector3d

Origin of plane.

setClipPlaneSequence

setClipPlaneSequence: (
    thePlaneSequenceIds: string,
    theOrPlaneSequence: string,
) => void

Set the list of clipping plane sequence ids.

Type declaration

    • (thePlaneSequenceIds: string, theOrPlaneSequence: string): void

    • Parameters

      • thePlaneSequenceIds: string

        List of clipping plane sequence ids.

      • theOrPlaneSequence: string

      Returns void

ReadonlysliceCount

sliceCount: number

Number of slices.

sliceNb

sliceNb: number

Current slice number.

sliceSize

sliceSize: number

Slice portion size.

updateBoundingBox

updateBoundingBox: () => void

update bounding box

Settings

Member Visibility

On This Page

Properties