# Clipping

class `cee.``Clipping`()

  Manages general clipping planes in a View.

  Anything behind (on the opposite side of the plane normal) the given planes is hidden.

  Note: The ug.RemoteModel has clipping support connect to cutting planes. These are handled separately,
    and the clipping planes for cutting planes will not show up here.

  Bounded clipping planes

  EnvisionWeb supports bounded clipping planes. This allows for cutting out parts of the model in many different ways. By default a clipping plane will clip an object/fragment if it is behind the specified plane (on the opposite side of the plane normal). Bounded clipping planes can be created by assigning all the wanted planes the same group ID when adding them, and then setting the clipping criteria for the group to ClippingCriteria.BehindAllPlanes.

  You can access the clipping object with the `View.clipping` property.

Accessors

- `planeCount`

Methods

- `addPlane`
- `getGroupId`
- `getPlane`
- `getPlaneArray`
- `removeAllPlanes`
- `removePlane`
- `setGroupClippingCriteria`
- `setPlane`

## Accessors

`Clipping.``planeCount`()

  The number of clipping planes in the view

  Return type: | number

## Methods

### addPlane

`Clipping.``addPlane`(plane, groupId)

  Arguments: | plane (`Plane`) – None groupId (`number`) – None

  Adds a clipping plane to the view.

  By default the plane clips anything behind the plane (on the opposite side of the plane normal). This can be changed by specifying the clipping criteria for the plane group to which this plane belongs using `Clipping.setGroupClippingCriteria`

  Return type: | void

### getGroupId

`Clipping.``getGroupId`(index)

  Arguments: | index (`number`) – None

  Return the group id of the plane at the specified index

  Return type: | number

### getPlane

`Clipping.``getPlane`(index)

  Arguments: | index (`number`) – None

  Return the Plane at the given index

  Return type: | Plane

### getPlaneArray

`Clipping.``getPlaneArray`()

  Returns a readonly array of all the planes in the view

  Return type: | unknown

### removeAllPlanes

`Clipping.``removeAllPlanes`()

  Removes all clipping planes in the view

  Also clears any plane groups and clipping criteria that has been specified

  Return type: | void

### removePlane

`Clipping.``removePlane`(index)

  Arguments: | index (`number`) – None

  Remove the clipping plane at the given index

  Return type: | void

### setGroupClippingCriteria

`Clipping.``setGroupClippingCriteria`(groupId, groupClippingCriteria)

  Arguments: | groupId (`number`) – None groupClippingCriteria (`ClippingCriteria`) – None

  Sets clipping criteria for the specified group of planes

  Return type: | void

### setPlane

`Clipping.``setPlane`(index, plane)

  Arguments: | index (`number`) – None plane (`Plane`) – None

  Sets a clipping plane at the given index.

  By default the plane clips anything behind the plane (on the opposite side of the plane normal).

  Return type: | void

Conversation saved
HOOPSY BETA

### Hello! I'm HOOPSY

Your Docs generative AI assistant. Ask me anything about HOOPS Envision for Web or choose a sample question below to start a conversation:

What is HOOPS Envision for Web?
What are the latest release notes for HOOPS Envision for Web?
How do I start evaluating HOOPS Envision for Web?
How do I write my first sample application?
How can I get assistance?

HOOPSY may store conversations according to OpenAI's policy. Responses may not always be accurate.

HOOPSY is thinking...