Bitbybit Docs
    Preparing search index...

    Class DesignReferenceForDto (Inputs.OCCT)

    A part document with the configuration, parameter values and asset contents to build it with, a body of it and faces or edges picked on that body, for design.referenceFor, which names them.

    Index

    Constructors

    • Parameters

      • Optionaldocument: DesignDocument
      • Optionalbody: string
      • Optionalfaces: number[]
      • Optionaledges: number[]
      • Optionalconfiguration: string
      • Optionalparameters: Record<string, number | string | boolean>
      • Optionalassets: Record<string, string | Uint8Array | ArrayBuffer>
      • Optionalnudge: boolean

      Returns DesignReferenceForDto

    Properties

    document: DesignDocument

    The part document with its parameters, features and parts.

    undefined
    
    body: string

    The body the elements were picked on, by the id of the feature that started it, as a part's body names it.

    undefined
    
    faces?: number[]

    The picked faces of the body, as indexes from 0; give these or edges.

    undefined
    

    true

    edges?: number[]

    The picked edges of the body, as indexes from 0; give these or faces.

    undefined
    

    true

    configuration?: string

    The id of one of the document's configurations, whose values replace the parameters' own; left out or empty, none is used.

    undefined
    

    true

    parameters?: Record<string, string | number | boolean>

    Values that replace the parameters of the same names after the configuration's, each read as the parameter's own value is, such as { width: 40 }.

    undefined
    

    true

    assets?: Record<string, string | ArrayBuffer | Uint8Array<ArrayBufferLike>>

    The contents of the document's assets by asset id, as text or bytes, for the features that import them.

    undefined
    

    true

    nudge?: boolean

    Whether to check the reference by building again with each number parameter the body depends on moved a little, one at a time.

    true