# ICuttingSection

class `ICuttingSection`()

  ## Index

  Methods

  - `_getInstanceNodeIds`
  - `activate`
  - `addPlane`
  - `applyPlaneOpacity`
  - `clear`
  - `deactivate`
  - `fromJson`
  - `getCount`
  - `getCuttingPlanes`
  - `getNodeId`
  - `getPlane`
  - `getPlaneColor`
  - `getPlaneIndexByNodeId`
  - `getPlaneLineColor`
  - `getPlaneOpacity`
  - `getReferenceGeometry`
  - `isActive`
  - `removePlane`
  - `resetPlanesOpacity`
  - `setColor`
  - `setOpacity`
  - `setPlane`
  - `setPlaneColor`
  - `setPlaneLineColor`
  - `setPlaneOpacity`
  - `toJson`
  - `updatePlane`

## Methods

`ICuttingSection.``_getInstanceNodeIds`()
  _getInstanceNodeIds(): number[]

  Returns: number[]

`ICuttingSection.``activate`()
  activate(): Promise

  Returns: Promise

`ICuttingSection.``addPlane`()
  addPlane(plane: `Plane`, referenceGeometry: (None | `Point3`[]), options: { color: `IColor`, lineColor: `IColor`, opacity: number }): Promise

  Parameters

  > plane: `Plane`

  > referenceGeometry: (None | `Point3`[])

  > options: { color: `IColor`, lineColor: `IColor`, opacity: number }

  Returns: Promise

`ICuttingSection.``applyPlaneOpacity`()
  applyPlaneOpacity(index: number, opacity: number): void

  Parameters

  > index: number

  > opacity: number

  Returns: void

`ICuttingSection.``clear`()
  clear(): Promise

  Returns: Promise

`ICuttingSection.``deactivate`()
  deactivate(): Promise

  Returns: Promise

`ICuttingSection.``fromJson`()
  fromJson(json: object): Promise

  Parameters

  > json: object

  Returns: Promise

`ICuttingSection.``getCount`()
  getCount(): number

  Returns: number

`ICuttingSection.``getCuttingPlanes`()
  getCuttingPlanes(): `CuttingPlane`[]

  Returns: `CuttingPlane`[]

`ICuttingSection.``getNodeId`()
  getNodeId(index: number): (None | number)

  Parameters

  > index: number

  Returns: (None | number)

`ICuttingSection.``getPlane`()
  getPlane(index: number): (None | `Plane`)

  Parameters

  > index: number

  Returns: (None | `Plane`)

`ICuttingSection.``getPlaneColor`()
  getPlaneColor(index: number): (undefined | `Color`)

  Parameters

  > index: number

  Returns: (undefined | `Color`)

`ICuttingSection.``getPlaneIndexByNodeId`()
  getPlaneIndexByNodeId(id: number): (None | number)

  Parameters

  > id: number

  Returns: (None | number)

`ICuttingSection.``getPlaneLineColor`()
  getPlaneLineColor(index: number): (undefined | `Color`)

  Parameters

  > index: number

  Returns: (undefined | `Color`)

`ICuttingSection.``getPlaneOpacity`()
  getPlaneOpacity(index: number): (undefined | number)

  Parameters

  > index: number

  Returns: (undefined | number)

`ICuttingSection.``getReferenceGeometry`()
  getReferenceGeometry(index: number): (None | `Point3`[])

  Parameters

  > index: number

  Returns: (None | `Point3`[])

`ICuttingSection.``isActive`()
  isActive(): boolean

  Returns: boolean

`ICuttingSection.``removePlane`()
  removePlane(index: number): Promise

  Parameters

  > index: number

  Returns: Promise

`ICuttingSection.``resetPlanesOpacity`()
  resetPlanesOpacity(): void

  Returns: void

`ICuttingSection.``setColor`()
  setColor(color: `Color`): Promise

  Parameters

  > color: `Color`

  Returns: Promise

`ICuttingSection.``setOpacity`()
  setOpacity(opacity: number): void

  Parameters

  > opacity: number

  Returns: void

`ICuttingSection.``setPlane`()
  setPlane(index: number, plane: `Plane`, referenceGeometry: (None | `Point3`[]), options: { color: `IColor`, lineColor: `IColor`, opacity: number }): Promise

  Parameters

  > index: number

  > plane: `Plane`

  > referenceGeometry: (None | `Point3`[])

  > options: { color: `IColor`, lineColor: `IColor`, opacity: number }

  Returns: Promise

`ICuttingSection.``setPlaneColor`()
  setPlaneColor(index: number, color: `Color`): void

  Parameters

  > index: number

  > color: `Color`

  Returns: void

`ICuttingSection.``setPlaneLineColor`()
  setPlaneLineColor(index: number, color: `Color`): void

  Parameters

  > index: number

  > color: `Color`

  Returns: void

`ICuttingSection.``setPlaneOpacity`()
  setPlaneOpacity(index: number, opacity: number): void

  Parameters

  > index: number

  > opacity: number

  Returns: void

`ICuttingSection.``toJson`()
  toJson(): object

  Returns: object

`ICuttingSection.``updatePlane`()
  updatePlane(index: number, plane: `Plane`, geometryMatrix: `Matrix`, finalizePosition: boolean, resetTranslation: boolean): Promise

  Parameters

  > index: number

  > plane: `Plane`

  > geometryMatrix: `Matrix`

  > finalizePosition: boolean

  > resetTranslation: boolean

  Returns: Promise

Conversation saved
HOOPSY BETA

### Hello! I'm HOOPSY

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

What is HOOPS Visualize Web?
What are the latest release notes for HOOPS Visualize Web?
How do I start evaluating HOOPS Visualize 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...