Reference Source
public class | source

FaceAlignedSectionPlanesControl

Controls a SectionPlane with mouse and touch input.

Member Summary

Public Members
public

ID of this FaceAlignedSectionPlanesControl.

public get

Gets the SectionPlane controlled by this FaceAlignedSectionPlanesControl.

Method Summary

Public Methods
public

Gets if this FaceAlignedSectionPlanesControl is visible.

public

setCulled(culled: *)

Sets if this FaceAlignedSectionPlanesControl is culled.

public

Sets if this FaceAlignedSectionPlanesControl is visible.

Public Members

public id: String | Number source

ID of this FaceAlignedSectionPlanesControl.

FaceAlignedSectionPlanesControl are mapped by this ID in FaceAlignedSectionPlanesPlugin#controls.

Properties:

NameTypeAttributeDescription
id *

public get sectionPlane: SectionPlane: * source

Gets the SectionPlane controlled by this FaceAlignedSectionPlanesControl.

Return:

SectionPlane

The SectionPlane.

Public Methods

public getVisible(): *: Boolean source

Gets if this FaceAlignedSectionPlanesControl is visible.

Return:

*

public setCulled(culled: *) source

Sets if this FaceAlignedSectionPlanesControl is culled. This is called by FaceAlignedSectionPlanesPlugin to temporarily hide the FaceAlignedSectionPlanesControl while a snapshot is being taken by Viewer#getSnapshot().

Params:

NameTypeAttributeDescription
culled *

public setVisible(visible: boolean): Boolean source

Sets if this FaceAlignedSectionPlanesControl is visible.

Params:

NameTypeAttributeDescription
visible boolean
  • optional
  • default: true