Bitbybit Docs
    Preparing search index...

    Class PrismFeatureDto<T, U> (Inputs.OCCT)

    A base shape, a profile face sketched on one of its faces and how far to sweep it for features.boss, which adds material, and features.pocket, which removes it.

    Type Parameters

    • T
    • U
    Index

    Constructors

    • Type Parameters

      • T
      • U

      Parameters

      • Optionalshape: T
      • Optionalprofile: U
      • OptionalsketchFaceIndex: number
      • Optionaldirection: Vector3
      • Optionalextent: featureExtentEnum
      • Optionallength: number
      • OptionaluntilFaceIndex: number

      Returns PrismFeatureDto<T, U>

    Properties

    shape: T

    The base shape the feature is built on.

    undefined
    
    profile: U

    The face to sweep; it must lie on the face of the base that sketchFaceIndex names.

    undefined
    
    sketchFaceIndex?: number

    The face of the base the profile lies on, counted from 0 as shapes.face.getFaces lists them.

    0
    

    0

    Infinity

    1

    direction?: Vector3

    The direction the profile travels in: away from the base for a boss, into it for a pocket.

    [0, 1, 0]
    

    Where the feature stops: after length, at the face untilFaceIndex names, or once it has passed through the whole base.

    length
    
    length?: number

    How far the profile travels when extent is length, in model units.

    1
    

    0

    true

    Infinity

    0.1

    untilFaceIndex?: number

    The face the feature stops at when extent is untilFace: one the profile meets on its way, such as the underside of an overhang or a void's ceiling.

    0
    

    0

    Infinity

    1