Class SectionPlane

destroyed

id

Readonlyview

active

• get active(): boolean

  Gets if this SectionPlane is active or not.

  Default value is true.

  Returns boolean

  Returns true if active.
• set active(value: boolean): void

  Sets if this SectionPlane is active or not.

  Default value is true.

  Parameters

  • value: boolean

    Set true to activate else false to deactivate.

  Returns void

dir

• get dir(): Vec3

  Gets the direction of this SectionPlane's plane.

  Default value is [0, 0, -1].

  Returns Vec3

  value Current direction.
• set dir(value: Vec3): void

  Sets the direction of this SectionPlane's plane.

  Default value is [0, 0, -1].

  Parameters

  • value: Vec3

    New direction.

  Returns void

dist

• get dist(): number

  Gets this SectionPlane's distance to the origin of the World-space coordinate system.

  This is the dot product of SectionPlane.pos and SectionPlane.dir and is automatically re-calculated each time either of two properties are updated.

  Returns number

  Distance to the origin of the World-space coordinate system.

pos

• get pos(): Vec3

  Gets the World-space position of this SectionPlane's plane.

  Default value is [0, 0, 0].

  Returns Vec3

  Current position.
• set pos(value: Vec3): void

  Sets the World-space position of this SectionPlane's plane.

  Default value is [0, 0, 0].

  Parameters

  • value: Vec3

    New position.

  Returns void

destroy

• destroy(): void

  Destroys this SectionPlane.

  Returns void

flipDir

• flipDir(): void

  Inverts the direction of SectionPlane.dir.

  Returns void

fromParams

• fromParams(sectionPlaneParams: SectionPlaneParams): SDKResult<void>

  COnfigures this SectionPlane.

  Parameters

  • sectionPlaneParams: SectionPlaneParams

  Returns SDKResult<void>

toParams

• toParams(): SDKResult<SectionPlaneParams>

  Gets the current configuration of this SectionPlane.

  Returns SDKResult<SectionPlaneParams>