Options
All
  • Public
  • Public/Protected
  • All
Menu

Draw options for OCCT shapes

Hierarchy

  • DrawOcctShapeOptions

Index

Constructors

constructor

  • new DrawOcctShapeOptions(faceOpacity?: number, edgeOpacity?: number, edgeColour?: string, faceMaterial?: any, faceColour?: string, edgeWidth?: number, drawEdges?: boolean, drawFaces?: boolean, drawVertices?: boolean, vertexColour?: string, vertexSize?: number, precision?: number, drawEdgeIndexes?: boolean, edgeIndexHeight?: number, edgeIndexColour?: string, drawFaceIndexes?: boolean, faceIndexHeight?: number, faceIndexColour?: string): DrawOcctShapeOptions
  • Provide options without default values

    Parameters

    • Optional faceOpacity: number
    • Optional edgeOpacity: number
    • Optional edgeColour: string
    • Optional faceMaterial: any
    • Optional faceColour: string
    • Optional edgeWidth: number
    • Optional drawEdges: boolean
    • Optional drawFaces: boolean
    • Optional drawVertices: boolean
    • Optional vertexColour: string
    • Optional vertexSize: number
    • Optional precision: number
    • Optional drawEdgeIndexes: boolean
    • Optional edgeIndexHeight: number
    • Optional edgeIndexColour: string
    • Optional drawFaceIndexes: boolean
    • Optional faceIndexHeight: number
    • Optional faceIndexColour: string

    Returns DrawOcctShapeOptions

Properties

drawEdgeIndexes

drawEdgeIndexes: boolean

Draw index of edges in space

default

false

drawEdges

drawEdges: boolean

You can turn off drawing of edges via this property

default

true

drawFaceIndexes

drawFaceIndexes: boolean

Draw indexes of faces in space

default

false

drawFaces

drawFaces: boolean

You can turn off drawing of faces via this property

default

true

drawVertices

drawVertices: boolean

You can turn off drawing of vertexes via this property

default

false

edgeColour

edgeColour: string

Hex colour string for the edges

default

#ffffff

edgeIndexColour

edgeIndexColour: string

Edge index colour if the edges are drawn

default

#ff00ff

edgeIndexHeight

edgeIndexHeight: number

Indicates the edge index height if they are drawn

default

0.06

minimum

0

maximum

Infinity

step

0.01

edgeOpacity

edgeOpacity: number

Edge opacity value between 0 and 1

default

1

minimum

0

maximum

1

step

0.1

edgeWidth

edgeWidth: number

Edge width

default

2

minimum

0

maximum

Infinity

step

0.1

faceColour

faceColour: string

Hex colour string for face colour

default

#ff0000

faceIndexColour

faceIndexColour: string

Edge index colour if the edges are drawn

default

#0000ff

faceIndexHeight

faceIndexHeight: number

Indicates the edge index height if they are drawn

default

0.06

minimum

0

maximum

Infinity

step

0.01

Optional faceMaterial

faceMaterial: any

Face material

default

undefined

optional

true

faceOpacity

faceOpacity: number

Face opacity value between 0 and 1

default

1

minimum

0

maximum

1

step

0.1

precision

precision: number

Precision of the mesh that will be generated for the shape, lower number will mean more triangles

default

0.01

minimum

0

maximum

Infinity

step

0.01

vertexColour

vertexColour: string

Color of the vertices that will be drawn

default

#ff00ff

vertexSize

vertexSize: number

The size of a vertices that will be drawn

default

0.03

minimum

0

maximum

Infinity

step

0.01

Generated using TypeDoc