editor › Globals › ShapeChange
Class: ShapeChange
Hierarchy
- ShapeChange
Index
Constructors
Properties
Methods
- getPolygon
- getSurfaces
- getVisualPriority
- isClickThrough
- setIsClickThrough
- setPolygon
- setSurfaces
- setVisualPriority
Constructors
constructor
+ new ShapeChange(polygon: Polygon | MultiPolygon, type: ShapeChangeType): ShapeChange
Defined in src/model/visualization/Plates/PlatePipeline/ShapeChange.ts:20
Parameters:
| Name | Type |
|---|---|
polygon |
Polygon | MultiPolygon |
type |
ShapeChangeType |
Returns: ShapeChange
Properties
Private clickThrough
• clickThrough: boolean = false
Defined in src/model/visualization/Plates/PlatePipeline/ShapeChange.ts:20
Private polygon
• polygon: MultiPolygon
Defined in src/model/visualization/Plates/PlatePipeline/ShapeChange.ts:17
Private surfaces
• surfaces: PlateRenderSurface[]
Defined in src/model/visualization/Plates/PlatePipeline/ShapeChange.ts:18
Readonly type
• type: ShapeChangeType
Defined in src/model/visualization/Plates/PlatePipeline/ShapeChange.ts:16
Private visualPriority
• visualPriority: ShapeChangePriority = ShapeChangePriority.Normal
Defined in src/model/visualization/Plates/PlatePipeline/ShapeChange.ts:19
Methods
getPolygon
▸ getPolygon(): MultiPolygon
Defined in src/model/visualization/Plates/PlatePipeline/ShapeChange.ts:27
Returns: MultiPolygon
getSurfaces
▸ getSurfaces(): PlateRenderSurface[]
Defined in src/model/visualization/Plates/PlatePipeline/ShapeChange.ts:39
Returns: PlateRenderSurface[]
getVisualPriority
▸ getVisualPriority(): ShapeChangePriority
Defined in src/model/visualization/Plates/PlatePipeline/ShapeChange.ts:47
Returns: ShapeChangePriority
isClickThrough
▸ isClickThrough(): boolean
Defined in src/model/visualization/Plates/PlatePipeline/ShapeChange.ts:62
If true, this shape change (of type ShapeChangeType.Cutout) should always be applied, so that raycasts will not hit it, but go through instead.
Returns: boolean
setIsClickThrough
▸ setIsClickThrough(clickThrough: boolean): void
Defined in src/model/visualization/Plates/PlatePipeline/ShapeChange.ts:51
Parameters:
| Name | Type |
|---|---|
clickThrough |
boolean |
Returns: void
setPolygon
▸ setPolygon(polygon: MultiPolygon): void
Defined in src/model/visualization/Plates/PlatePipeline/ShapeChange.ts:31
Parameters:
| Name | Type |
|---|---|
polygon |
MultiPolygon |
Returns: void
setSurfaces
▸ setSurfaces(surfaces: PlateRenderSurface[]): void
Defined in src/model/visualization/Plates/PlatePipeline/ShapeChange.ts:35
Parameters:
| Name | Type |
|---|---|
surfaces |
PlateRenderSurface[] |
Returns: void
setVisualPriority
▸ setVisualPriority(visualPriority: ShapeChangePriority): void
Defined in src/model/visualization/Plates/PlatePipeline/ShapeChange.ts:43
Parameters:
| Name | Type |
|---|---|
visualPriority |
ShapeChangePriority |
Returns: void