Skip to content

editor › Globals › SurfaceDisplayAnnotation

Class: SurfaceDisplayAnnotation

Holds information exclusively used by the HullPlateRealizer to display the mesh as plates.

Hierarchy

↳ SurfaceDisplayAnnotation

Index

Properties

Methods

Object literals

Properties

Private backSurfaceTextureOffset

• backSurfaceTextureOffset: Vector3‹› = new Vector3()

Defined in src/model/data/Concepts/Mesh/SurfaceDisplayAnnotation.ts:31

Protected Readonly changeEventEmitter

• changeEventEmitter: EventEmitter‹void› = new EventEmitter()

Inherited from MeshAnnotation.changeEventEmitter

Defined in src/model/data/Concepts/Mesh/MeshAnnotation.ts:20

Child classes should fire this event if their values changed and the mesh should know about it.

Private frontSurfaceTextureOffset

• frontSurfaceTextureOffset: Vector3‹› = new Vector3()

Defined in src/model/data/Concepts/Mesh/SurfaceDisplayAnnotation.ts:29

Private highlightedIn

• highlightedIn: [Color, number] = null

Defined in src/model/data/Concepts/Mesh/SurfaceDisplayAnnotation.ts:39

Private isPolished

• isPolished: boolean = Config.get("svgExport.fabricationSettings.defaultPolished2", true)

Defined in src/model/data/Concepts/Mesh/SurfaceDisplayAnnotation.ts:38

Methods

Protected _cloneWith

▸ _cloneWith(newAnchor: PointOnSurfaceAnchor): MeshAnnotation

Overrides MeshAnnotation._cloneWith

Defined in src/model/data/Concepts/Mesh/SurfaceDisplayAnnotation.ts:160

Parameters:

Name Type
newAnchor PointOnSurfaceAnchor

Returns: MeshAnnotation

destroy

▸ destroy(): void

Inherited from MeshAnnotation.destroy

Defined in src/model/data/Concepts/Mesh/MeshAnnotation.ts:45

Returns: void

getAnchor

▸ getAnchor(): IMeshAnchor

Inherited from MeshAnnotation.getAnchor

Defined in src/model/data/Concepts/Mesh/MeshAnnotation.ts:52

Returns: IMeshAnchor

the anchor that points to the target

getBackSurfaceTextureOffset

▸ getBackSurfaceTextureOffset(): Vector3‹›

Defined in src/model/data/Concepts/Mesh/SurfaceDisplayAnnotation.ts:112

Returns: Vector3‹›

the offset (point in texture coordinate system) of the texture that is used to cover the back side of the plate

getChangeEventEmitter

▸ getChangeEventEmitter(): IPublicEventEmitterInterface‹void›

Inherited from MeshAnnotation.getChangeEventEmitter

Defined in src/model/data/Concepts/Mesh/MeshAnnotation.ts:56

Returns: IPublicEventEmitterInterface‹void›

getFrontSurfaceTextureOffset

▸ getFrontSurfaceTextureOffset(): Vector3‹›

Defined in src/model/data/Concepts/Mesh/SurfaceDisplayAnnotation.ts:54

Returns: Vector3‹›

The offset (point in texture coordinate system) of the texture that is used to cover the front side of the plate

getHighlightedIn

▸ getHighlightedIn(): [Color, number]

Defined in src/model/data/Concepts/Mesh/SurfaceDisplayAnnotation.ts:151

Controls if the plate should be highlighted.

Returns: [Color, number]

getInMeshTarget

▸ getInMeshTarget(): MeshElement

Inherited from MeshAnnotation.getInMeshTarget

Defined in src/model/data/Concepts/Mesh/MeshAnnotation.ts:63

Returns: MeshElement

what this annotation points to inside the mesh

getIsPolished

▸ getIsPolished(): boolean

Defined in src/model/data/Concepts/Mesh/SurfaceDisplayAnnotation.ts:132

Controls if the plate should appear and be exported polished, meaning that finger joints are exported longer as they are expected to be sanded off afterwards (true) or should be exported so short that they don't need post-processing (false).

Returns: boolean

getMaterial

▸ getMaterial(): IPlateMaterial

Defined in src/model/data/Concepts/Mesh/SurfaceDisplayAnnotation.ts:58

Returns: IPlateMaterial

getMaterialColor

▸ getMaterialColor(): number | null

Defined in src/model/data/Concepts/Mesh/SurfaceDisplayAnnotation.ts:89

Returns: number | null

getMaterialThickness

▸ getMaterialThickness(): number

Defined in src/model/data/Concepts/Mesh/SurfaceDisplayAnnotation.ts:77

Returns: number

getMaterialType

▸ getMaterialType(): string

Defined in src/model/data/Concepts/Mesh/SurfaceDisplayAnnotation.ts:69

Returns: string

getTextureCoordinateSystem

▸ getTextureCoordinateSystem(): IReadOnlyTransforms

Defined in src/model/data/Concepts/Mesh/SurfaceDisplayAnnotation.ts:46

Returns: IReadOnlyTransforms

The transforms that define a local texture coordinate system. This is a special property, as it is directly defined by the annotation's anchor and no additional attribute. The texture coordinate system lies directly in the assembly's coordinate system.

setAnchor

▸ setAnchor(anchor: IMeshAnchor): void

Inherited from MeshAnnotation.setAnchor

Defined in src/model/data/Concepts/Mesh/MeshAnnotation.ts:24

Parameters:

Name Type
anchor IMeshAnchor

Returns: void

setBackSurfaceTextureOffset

▸ setBackSurfaceTextureOffset(offset: Vector3): void

Defined in src/model/data/Concepts/Mesh/SurfaceDisplayAnnotation.ts:120

see getBackSurfaceTextureOffset()

Parameters:

Name Type Description
offset Vector3 -

Returns: void

setFrontSurfaceTextureOffset

▸ setFrontSurfaceTextureOffset(offset: Vector3): void

Defined in src/model/data/Concepts/Mesh/SurfaceDisplayAnnotation.ts:101

see getFrontSurfaceTextureOffset()

Parameters:

Name Type Description
offset Vector3 New offset, in texture coordinates

Returns: void

setHighlightedIn

▸ setHighlightedIn(highlightedIn: Color, alpha: number): void

Defined in src/model/data/Concepts/Mesh/SurfaceDisplayAnnotation.ts:155

Parameters:

Name Type
highlightedIn Color
alpha number

Returns: void

setIsPolished

▸ setIsPolished(isPolished: boolean): void

Defined in src/model/data/Concepts/Mesh/SurfaceDisplayAnnotation.ts:141

Parameters:

Name Type
isPolished boolean

Returns: void

setMaterial

▸ setMaterial(material: IPlateMaterial): void

Defined in src/model/data/Concepts/Mesh/SurfaceDisplayAnnotation.ts:62

Parameters:

Name Type
material IPlateMaterial

Returns: void

setMaterialColor

▸ setMaterialColor(color: number | null): void

Defined in src/model/data/Concepts/Mesh/SurfaceDisplayAnnotation.ts:93

Parameters:

Name Type
color number | null

Returns: void

setMaterialThickness

▸ setMaterialThickness(thickness: number): this

Defined in src/model/data/Concepts/Mesh/SurfaceDisplayAnnotation.ts:84

Parameters:

Name Type
thickness number

Returns: this

this, for chaining

setMaterialType

▸ setMaterialType(type: string): void

Defined in src/model/data/Concepts/Mesh/SurfaceDisplayAnnotation.ts:73

Parameters:

Name Type
type string

Returns: void

Static fromSurface

▸ fromSurface(mesh: Mesh, surface: MeshSurface, point?: Vector3): SurfaceDisplayAnnotation‹›

Defined in src/model/data/Concepts/Mesh/SurfaceDisplayAnnotation.ts:21

Parameters:

Name Type Description
mesh Mesh -
surface MeshSurface -
point? Vector3 Point in assembly coordinates

Returns: SurfaceDisplayAnnotation‹›

Object literals

Private material

▪ material: object

Defined in src/model/data/Concepts/Mesh/SurfaceDisplayAnnotation.ts:33

color

• color: any = Config.get("plates.defaultMaterialColor", null)

Defined in src/model/data/Concepts/Mesh/SurfaceDisplayAnnotation.ts:36

thickness

• thickness: any = Config.get("plates.defaultMaterialThickness", 4)

Defined in src/model/data/Concepts/Mesh/SurfaceDisplayAnnotation.ts:35

type

• type: any = Config.get("plates.defaultMaterialType", "poplar")

Defined in src/model/data/Concepts/Mesh/SurfaceDisplayAnnotation.ts:34