Bitbybit Docs
    Preparing search index...

    Class DesignClashesDto (Inputs.OCCT)

    A design document with the configuration, parameter values, asset contents and the documents an assembly places, and the clearance to keep, for design.clashes, which finds the placed parts that overlap or come too close.

    Index

    Constructors

    • Parameters

      • Optionaldocument: DesignDocument
      • Optionaldocuments: DesignDocument[]
      • Optionalconfiguration: string
      • Optionalparameters: Record<string, number | string | boolean>
      • Optionalassets: Record<string, string | Uint8Array | ArrayBuffer>
      • Optionalclearance: number

      Returns DesignClashesDto

    Properties

    document: DesignDocument

    The document: an assembly document with its components, or a part document whose parts are checked where they were built.

    undefined
    
    documents?: DesignDocument[]

    The documents an assembly's components place, each with the id they name it by.

    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

    clearance?: number

    How close two placed parts may come before they clash; 0 reports only parts that touch or overlap.

    0
    

    0

    Infinity

    0.1