Bitbybit Docs
    Preparing search index...

    Class DrawManifoldsOrCrossSectionsDto<T, M> (Inputs.Manifold)

    Solids or cross-sections and how to draw them, for the renderer packages: the same options as DrawManifoldOrCrossSectionDto, applied to every shape in the list.

    Type Parameters

    • T
    • M
    Index

    Constructors

    • Provide options without default values

      Type Parameters

      • T
      • M

      Parameters

      • OptionalmanifoldsOrCrossSections: T[]
      • OptionalfaceOpacity: number
      • OptionalfaceMaterial: M
      • OptionalfaceColour: string
      • OptionalcrossSectionColour: string
      • OptionalcrossSectionWidth: number
      • OptionalcrossSectionOpacity: number
      • OptionalcomputeNormals: boolean
      • OptionaldrawTwoSided: boolean
      • OptionalbackFaceColour: string
      • OptionalbackFaceOpacity: number

      Returns DrawManifoldsOrCrossSectionsDto<T, M>

    Properties

    manifoldsOrCrossSections?: T[]

    The solids or cross-sections to draw with the same options.

    undefined
    

    true

    faceMaterial?: M

    A material for the faces from the rendering engine; when given it replaces the face color.

    undefined
    

    true

    faceColour: string

    The color of the faces as a hex string such as #ff0000.

    #ff0000
    
    faceOpacity: number

    How opaque the faces are, from 0 for invisible to 1 for solid.

    1
    

    0

    1

    0.1

    crossSectionColour: string

    The color of a cross-section's lines as a hex string.

    #ff00ff
    
    crossSectionWidth: number

    How thick a cross-section's lines are drawn.

    2
    
    crossSectionOpacity: number

    How opaque a cross-section's lines are, from 0 to 1.

    1
    

    0

    1

    0.1

    computeNormals: boolean

    When true, normals are computed for the meshes so they shade smoothly.

    false
    
    drawTwoSided: boolean

    When true, the back of each face is drawn in its own color, which shows which way faces point.

    true
    
    backFaceColour: string

    The color of the back of the faces as a hex string; used only with drawTwoSided.

    #0000ff
    
    backFaceOpacity: number

    How opaque the back of the faces is, from 0 to 1; used only with drawTwoSided.

    1
    

    0

    1

    0.1