bitbybit.dev v1.0.0-rc.1
    Preparing search index...

    Class DrawOcctShapeOptions

    Draw options for OCCT shapes

    Index

    Constructors

    • Provide options without default values

      Parameters

      • OptionalfaceOpacity: number
      • OptionaledgeOpacity: number
      • OptionaledgeColour: string
      • OptionalfaceMaterial: any
      • OptionalfaceColour: string
      • OptionaledgeWidth: number
      • OptionaldrawEdges: boolean
      • OptionaldrawFaces: boolean
      • OptionaldrawVertices: boolean
      • OptionalvertexColour: string
      • OptionalvertexSize: number
      • Optionalprecision: number
      • OptionaldrawEdgeIndexes: boolean
      • OptionaledgeIndexHeight: number
      • OptionaledgeIndexColour: string
      • OptionaldrawFaceIndexes: boolean
      • OptionalfaceIndexHeight: number
      • OptionalfaceIndexColour: string
      • OptionaldrawTwoSided: boolean
      • OptionalbackFaceColour: string
      • OptionalbackFaceOpacity: number
      • OptionaledgeArrowSize: number
      • OptionaledgeArrowAngle: number

      Returns DrawOcctShapeOptions

    Properties

    faceOpacity: number

    Face opacity value between 0 and 1

    1
    

    0

    1

    0.1

    edgeOpacity: number

    Edge opacity value between 0 and 1

    1
    

    0

    1

    0.1

    edgeColour: string

    Hex colour string for the edges

    #ffffff
    
    faceColour: string

    Hex colour string for face colour

    #ff0000
    
    vertexColour: string

    Color of the vertices that will be drawn

    #ff00ff
    
    faceMaterial?: any

    Face material

    undefined
    

    true

    edgeWidth: number

    Edge width

    2
    

    0

    Infinity

    0.1

    vertexSize: number

    The size of a vertices that will be drawn

    0.03
    

    0

    Infinity

    0.01

    drawEdges: boolean

    You can turn off drawing of edges via this property

    true
    
    drawFaces: boolean

    You can turn off drawing of faces via this property

    true
    
    drawVertices: boolean

    You can turn off drawing of vertexes via this property

    false
    
    precision: number

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

    0.01
    

    0

    Infinity

    0.01

    drawEdgeIndexes: boolean

    Draw index of edges in space

    false
    
    edgeIndexHeight: number

    Indicates the edge index height if they are drawn

    0.06
    

    0

    Infinity

    0.01

    edgeIndexColour: string

    Edge index colour if the edges are drawn

    #ff00ff
    
    drawFaceIndexes: boolean

    Draw indexes of faces in space

    false
    
    faceIndexHeight: number

    Indicates the edge index height if they are drawn

    0.06
    

    0

    Infinity

    0.01

    faceIndexColour: string

    Edge index colour if the edges are drawn

    #0000ff
    
    drawTwoSided: boolean

    Draw two-sided faces with different colors for front and back. This helps visualize face orientation.

    true
    
    backFaceColour: string

    Hex colour string for back face colour (negative side of the face). Only used when drawTwoSided is true.

    #0000ff
    
    backFaceOpacity: number

    Back face opacity value between 0 and 1. Only used when drawTwoSided is true.

    1
    

    0

    1

    0.1

    edgeArrowSize: number

    Size of arrow heads at the end of edges to indicate edge/wire orientation. Set to 0 to disable arrows.

    0
    

    0

    Infinity

    0.01

    edgeArrowAngle: number

    Angle of the arrow head in degrees. Controls how wide the arrow head spreads.

    15
    

    0

    90

    1