ClipPlaneAPI

• webVis API Reference
• ClipPlaneAPI

Interface ClipPlaneAPI

interface ClipPlaneAPI {
    changeClippingRoom(properties?: ClipRoomProperties): ClipRoomProperties;
    changeClippingRoom(
        name?: string,
        size?: number[] | Float32Array<ArrayBufferLike>,
        transformation?: number[] | Float32Array<ArrayBufferLike>,
        disabled?: boolean,
        invisible?: boolean,
    ): ClipRoomProperties;
    changeClipPlane(
        clipPlaneId: number,
        properties: ClipPlaneProperties,
    ): ClipPlaneProperties;
    changeClipPlane(
        clipPlaneID: number,
        normal?: number[] | Float32Array<ArrayBufferLike>,
        point?: number[] | Float32Array<ArrayBufferLike>,
        name?: string,
        thickness?: number,
        tangent?: number[] | Float32Array<ArrayBufferLike>,
        disabled?: boolean,
        invisible?: boolean,
        exclusive?: boolean,
    ): void;
    clipOtherParts(target: number | number[]): void;
    createCapping(clipPlaneId: number): Promise<void>;
    createClippingRoom(properties?: ClipRoomProperties): void;
    createClippingRoom(
        name?: string,
        size?: number[] | Float32Array<ArrayBufferLike>,
        transformation?: number[] | Float32Array<ArrayBufferLike>,
        disabled?: boolean,
        invisible?: boolean,
    ): void;
    createClipPlane(properties?: ClipPlaneProperties): number;
    createClipPlane(
        normal?: number[] | Float32Array<ArrayBufferLike>,
        point?: number[] | Float32Array<ArrayBufferLike>,
        name?: string,
        thickness?: number,
        tangent?: number[] | Float32Array<ArrayBufferLike>,
        disabled?: boolean,
        invisible?: boolean,
        exclusive?: boolean,
    ): number;
    disableCapping(clipPlaneId: number): Promise<void>;
    enableCapping(clipPlaneId: number): Promise<void>;
    getClipPlanes(): number[];
    getClipRoom(): number;
    removeCapping(clipPlaneId: number): Promise<void>;
    removeClippingRoom(safe?: boolean): RemoveState;
    removeClipPlane(clipPlaneId: number, safe?: boolean): RemoveState;
    requestClipPlaneData(clipPlaneId: number): Promise<ClipPlaneProperties>;
    requestClipRoomData(): Promise<ClipRoomProperties>;
}

Hierarchy (View Summary)

• ClipPlaneAPI
  • ContextAPI

Index

Methods

changeClippingRoom changeClipPlane clipOtherParts createCapping createClippingRoom createClipPlane disableCapping enableCapping getClipPlanes getClipRoom removeCapping removeClippingRoom removeClipPlane requestClipPlaneData requestClipRoomData

Methods

changeClippingRoom

• changeClippingRoom(properties?: ClipRoomProperties): ClipRoomProperties

• Changes one or more properties of the clip room.

  Parameters

  • Optionalproperties: ClipRoomProperties

    The properties of the clip room you want change.

  Returns ClipRoomProperties

  An object with the changed properties.
• changeClippingRoom(
      name?: string,
      size?: number[] | Float32Array<ArrayBufferLike>,
      transformation?: number[] | Float32Array<ArrayBufferLike>,
      disabled?: boolean,
      invisible?: boolean,
  ): ClipRoomProperties

• Parameters

  • Optionalname: string

    The name of the clip room.
  • Optionalsize: number[] | Float32Array<ArrayBufferLike>

    The size of the clip room.
  • Optionaltransformation: number[] | Float32Array<ArrayBufferLike>

    The transformation of the clip room.
  • Optionaldisabled: boolean

    The disabled state of the clip room.
  • Optionalinvisible: boolean

    The invisible state of the clip room.

  Returns ClipRoomProperties

  An object with the changed properties.

  Deprecated

  Calling changeClippingRoom with single parameters is deprecated, please use ClipRoomProperties instead.

  Changes one or more properties of the clip room.

changeClipPlane

• changeClipPlane(
      clipPlaneId: number,
      properties: ClipPlaneProperties,
  ): ClipPlaneProperties

• Changes one or more properties of a clip plane with the specified id.

  Parameters

  • clipPlaneId: number

    The id of the clip plane you want to change.
  • properties: ClipPlaneProperties

    The properties of the clip plane you want change.

  Returns ClipPlaneProperties

  An Object with the changed Properties.
• changeClipPlane(
      clipPlaneID: number,
      normal?: number[] | Float32Array<ArrayBufferLike>,
      point?: number[] | Float32Array<ArrayBufferLike>,
      name?: string,
      thickness?: number,
      tangent?: number[] | Float32Array<ArrayBufferLike>,
      disabled?: boolean,
      invisible?: boolean,
      exclusive?: boolean,
  ): void

• Changes the properties of the clip plane defined by the clipPlaneID with the optional parameters normal, points and name.

  Parameters

  • clipPlaneID: number

    The ID of an existing clip plane which should be changed
  • Optionalnormal: number[] | Float32Array<ArrayBufferLike>

    The new normal of the clip plane
  • Optionalpoint: number[] | Float32Array<ArrayBufferLike>

    An arbitrary new point in space which lies on the clip plane
  • Optionalname: string

    The new name for the clip plane
  • Optionalthickness: number

    The thickness for the clip plane
  • Optionaltangent: number[] | Float32Array<ArrayBufferLike>

    The tangent of the clip plane
  • Optionaldisabled: boolean

    The enabled state of the clip plane
  • Optionalinvisible: boolean

    Invisible on the UI
  • Optionalexclusive: boolean

    set the exclusive flag to clip geometry when using exclusiveClipplanes property

  Returns void

  Deprecated

  Calling changeClipPlane with single parameters is deprecated, please use ClipPlaneProperties instead.

clipOtherParts

• clipOtherParts(target: number | number[]): void

• Creates a clip room around the box volume of the specified node.

  Parameters

  • target: number | number[]

    ID(s) of the target Node(s).

  Returns void

createCapping

• createCapping(clipPlaneId: number): Promise<void>
• Experimental

  Generates capping geometry for the surface that is cut by the clip plane. The generated surfaces allow measurements and all other operations which can be performed on usual geometry.

  Parameters

  • clipPlaneId: number

    the id of the clip plane

  Returns Promise<void>

createClippingRoom

• createClippingRoom(properties?: ClipRoomProperties): void

• Creates a new clip room.

  Parameters

  • Optionalproperties: ClipRoomProperties

    Initial properties of the created clip room.

  Returns void
• createClippingRoom(
      name?: string,
      size?: number[] | Float32Array<ArrayBufferLike>,
      transformation?: number[] | Float32Array<ArrayBufferLike>,
      disabled?: boolean,
      invisible?: boolean,
  ): void

• Parameters

  • Optionalname: string

    The name of the clip room.
  • Optionalsize: number[] | Float32Array<ArrayBufferLike>

    The size of the clip room.
  • Optionaltransformation: number[] | Float32Array<ArrayBufferLike>

    The transformation of the clip room.
  • Optionaldisabled: boolean

    The disabled state of the clip room.
  • Optionalinvisible: boolean

    The invisible state of the clip room.

  Returns void

  Deprecated

  Calling createClippingRoom with single parameters is deprecated, please use ClipRoomProperties instead.

  Creates a new clip room.

createClipPlane

• createClipPlane(properties?: ClipPlaneProperties): number

• Creates a new clip plane.

  Parameters

  • Optionalproperties: ClipPlaneProperties

    Initial properties of the created clip plane.

  Returns number

  The id of the newly created clip plane.
• createClipPlane(
      normal?: number[] | Float32Array<ArrayBufferLike>,
      point?: number[] | Float32Array<ArrayBufferLike>,
      name?: string,
      thickness?: number,
      tangent?: number[] | Float32Array<ArrayBufferLike>,
      disabled?: boolean,
      invisible?: boolean,
      exclusive?: boolean,
  ): number

• Creates a clip plane defined by the plane’s normal, positioned at an optional point (otherwise at the world space origin) and an optional name. Returns the ID of the clip plane.

  Parameters

  • Optionalnormal: number[] | Float32Array<ArrayBufferLike>

    The normal of the clip plane
  • Optionalpoint: number[] | Float32Array<ArrayBufferLike>

    An arbitrary point in space which lies on the clip plane
  • Optionalname: string

    The name of the clip plane
  • Optionalthickness: number

    The thickness of the clip plane
  • Optionaltangent: number[] | Float32Array<ArrayBufferLike>

    The tangent of the clip plane
  • Optionaldisabled: boolean

    The state of the clip plane
  • Optionalinvisible: boolean

    Invisible on the UI
  • Optionalexclusive: boolean

    set the exclusive flag to clip geometry when using exclusiveClipplanes property

  Returns number

  The ID of the newly created clip plane

  Deprecated

  Calling createClipPlane with single parameters is deprecated, please use ClipPlaneProperties instead.

disableCapping

• disableCapping(clipPlaneId: number): Promise<void>
• Experimental

  Disables the generated capping geometry.

  Parameters

  • clipPlaneId: number

    the id of the clip plane

  Returns Promise<void>

enableCapping

• enableCapping(clipPlaneId: number): Promise<void>
• Experimental

  Enables the generated capping geometry.

  Parameters

  • clipPlaneId: number

    the id of the clip plane

  Returns Promise<void>

getClipPlanes

• getClipPlanes(): number[]

• Returns the ids of all available clip planes.

  Returns number[]

  The ids of all available clip planes.

getClipRoom

• getClipRoom(): number

• Returns the id the clip room.

  Returns number

  The id the clip room.

removeCapping

• removeCapping(clipPlaneId: number): Promise<void>
• Experimental

  Removes the generated capping geometry.

  Parameters

  • clipPlaneId: number

    the id of the clip plane

  Returns Promise<void>

removeClippingRoom

• removeClippingRoom(safe?: boolean): RemoveState

• Removes the clip room from the scene and all related Snapshots.

  Parameters

  • Optionalsafe: boolean

    Performs a safe remove which interrupt the removal process if the ClipRoom is part of one or more Snapshots.

  Returns RemoveState

removeClipPlane

• removeClipPlane(clipPlaneId: number, safe?: boolean): RemoveState

• Removes a clip room with the specified id.

  Parameters

  • clipPlaneId: number

    The id of the clip room you want to remove.
  • Optionalsafe: boolean

    Performs a safe remove which interrupt the removal process if the ClipPlane is part of one or more Snapshots.

  Returns RemoveState

requestClipPlaneData

• requestClipPlaneData(clipPlaneId: number): Promise<ClipPlaneProperties>

• Returns the ClipPlaneData for the specified clip plane id.

  Parameters

  • clipPlaneId: number

    The id of the clip plane you want to request the data for.

  Returns Promise<ClipPlaneProperties>

  The requested clip plane data.

requestClipRoomData

• requestClipRoomData(): Promise<ClipRoomProperties>

• Returns the ClipRoomData.

  Returns Promise<ClipRoomProperties>

  The requested clip room data.

---

Did you find this page useful? Please give it a rating:

★ ★ ★ ★ ★

Thank you for rating this page!

Any issues or feedback?

What kind of problem would you like to report?

• This page needs code samples
• Code samples do not work
• Information is missing
  Please tell us more about what's wrong:
• Information is incorrect
  Please tell us more about what's wrong:
• Information is unclear or confusing
  Please tell us more about what's wrong:
• The page is rendered incorrectly (styling/CSS)
• Give Feedback

Please tell us more about what's wrong: Name E-Mail Problem (required)