Options
All
  • Public
  • Public/Protected
  • All
Menu
Logo of bit by bit developers

Class OCCTWire

Hierarchy

  • OCCTWire

Index

Constructors

constructor

  • new OCCTWire(occWorkerManager: OCCTWorkerManager): OCCTWire
  • Parameters

    • occWorkerManager: OCCTWorkerManager

    Returns OCCTWire

Methods

addEdgesAndWiresToWire

closeOpenWire

  • Closes the open wire with additional straight edge joining start and end points

    group

    edit

    shortname

    close open wire

    drawable

    true

    Parameters

    Returns Promise<TopoDSWirePointer>

    OpenCascade wire

combineEdgesAndWiresIntoAWire

createBSpline

  • Creates OpenCascade BSPline wire

    group

    via points

    shortname

    bspline

    drawable

    true

    Parameters

    • inputs: BSplineDto

      Points through which to make BSpline

    Returns Promise<TopoDSWirePointer>

    OpenCascade BSpline wire

createBSplines

  • Creates OpenCascade BSPline wires

    group

    multiple

    shortname

    bsplines

    drawable

    true

    Parameters

    • inputs: BSplinesDto

      Points through which to make BSpline

    Returns Promise<TopoDSCompoundPointer | TopoDSWirePointer[]>

    OpenCascade BSpline wires

createBezier

  • Creates OpenCascade Bezier wire

    group

    via points

    shortname

    bezier

    drawable

    true

    Parameters

    • inputs: BezierDto

      Points through which to make bezier curve

    Returns Promise<TopoDSWirePointer>

    OpenCascade Bezier wire

createBezierWires

  • Creates OpenCascade Bezier wires

    group

    multiple

    shortname

    bezier wires

    drawable

    true

    Parameters

    Returns Promise<TopoDSCompoundPointer | TopoDSWirePointer[]>

    OpenCascade Bezier wires

createChristmasTreeWire

  • Creates Christmas tree wire

    group

    primitives

    shortname

    christmas tree

    drawable

    true

    Parameters

    Returns Promise<TopoDSWirePointer>

    OpenCascade christmas tree wire

createCircleWire

  • Creates OpenCascade circle wire

    group

    primitives

    shortname

    circle

    drawable

    true

    Parameters

    Returns Promise<TopoDSWirePointer>

    OpenCascade circle wire

createEllipseWire

  • Creates OpenCascade ellipse wire

    group

    primitives

    shortname

    ellipse

    drawable

    true

    Parameters

    Returns Promise<TopoDSWirePointer>

    OpenCascade ellipse wire

createHeartWire

  • Creates a heart wire

    group

    primitives

    shortname

    heart

    drawable

    true

    Parameters

    Returns Promise<TopoDSWirePointer>

    OpenCascade heart shaped wire

createLPolygonWire

  • Creates OpenCascade L polygon wire

    group

    primitives

    shortname

    L polygon

    drawable

    true

    Parameters

    Returns Promise<TopoDSWirePointer>

    OpenCascade polygon

createLineWire

  • Creates OpenCascade line wire

    group

    via points

    shortname

    line

    drawable

    true

    Parameters

    • inputs: LineDto

      line start and end point

    Returns Promise<TopoDSWirePointer | TopoDSCompoundPointer>

    OpenCascade line wire shape

createLines

  • Creates OpenCascade lines

    group

    multiple

    shortname

    lines

    drawable

    true

    Parameters

    • inputs: LinesDto

      lines with start and end points

    Returns Promise<TopoDSCompoundPointer | TopoDSWirePointer[]>

    OpenCascade line wire shapes

createNGonWire

  • Creates OpenCascade n-gon wire

    group

    primitives

    shortname

    n-gon

    drawable

    true

    Parameters

    Returns Promise<TopoDSWirePointer>

    OpenCascade ngon wire

createParallelogramWire

  • Creates n parallelogram wire

    group

    primitives

    shortname

    parallelogram

    drawable

    true

    Parameters

    Returns Promise<TopoDSWirePointer>

    OpenCascade parallelogram wire

createPolygonWire

  • Creates OpenCascade Polygon wire

    group

    via points

    shortname

    polygon

    drawable

    true

    Parameters

    Returns Promise<TopoDSWirePointer>

    OpenCascade polygon wire shape

createPolygons

  • Creates OpenCascade Polygons

    group

    multiple

    shortname

    polygons

    drawable

    true

    Parameters

    Returns Promise<TopoDSCompoundPointer | TopoDSWirePointer[]>

    OpenCascade polygon wires shapes

createPolylineWire

  • Creates OpenCascade polyline wire

    group

    via points

    shortname

    polyline

    drawable

    true

    Parameters

    Returns Promise<TopoDSWirePointer>

    OpenCascade polyline wire shape

createPolylines

  • Creates OpenCascade polyline wires

    group

    multiple

    shortname

    polylines

    drawable

    true

    Parameters

    Returns Promise<TopoDSCompoundPointer | TopoDSWirePointer[]>

    OpenCascade polyline wire shapes

createRectangleWire

  • Creates OpenCascade rectangle wire

    group

    primitives

    shortname

    rectangle

    drawable

    true

    Parameters

    Returns Promise<TopoDSWirePointer>

    OpenCascade rectangle

createSquareWire

  • Creates OpenCascade square wire

    group

    primitives

    shortname

    square

    drawable

    true

    Parameters

    Returns Promise<TopoDSWirePointer>

    OpenCascade square wire

createStarWire

  • Creates OpenCascade star wire

    group

    primitives

    shortname

    star

    drawable

    true

    Parameters

    Returns Promise<TopoDSWirePointer>

    OpenCascade star wire

createWireFromEdge

  • Creates wire from edge

    group

    build

    shortname

    wire from edge

    drawable

    true

    Parameters

    Returns Promise<TopoDSWirePointer>

    OpenCascade wire

createZigZagBetweenTwoWires

  • Creates zig zag between two wires

    group

    via wires

    shortname

    zig zag between two wires

    drawable

    true

    Parameters

    Returns Promise<TopoDSWirePointer>

    OpenCascade polyline wire shape

derivativesOnWireAtLength

  • Computes 3 derivative vectors of a curve at a given length

    group

    extract

    shortname

    derivatives at length

    drawable

    false

    Parameters

    Returns Promise<[Vector3, Vector3, Vector3]>

    Three arrays of vectors. Each vector represents derivatives in order - first, second, third

derivativesOnWireAtParam

  • Computes 3 derivative vectors of a curve on parameter between 0 and 1.

    group

    extract

    shortname

    derivatives at param

    drawable

    false

    Parameters

    Returns Promise<[Vector3, Vector3, Vector3]>

    Three arrays of vectors. Each vector represents derivatives in order - first, second, third

divideWireByEqualDistanceToPoints

  • Divides OpenCascade wire to equal distance points

    group

    extract

    shortname

    points by distance

    drawable

    true

    Parameters

    Returns Promise<Point3[]>

    Points on wire

divideWireByParamsToPoints

  • Divides OpenCascade wire to points blindly following its parametric space

    group

    extract

    shortname

    points by params

    drawable

    true

    Parameters

    Returns Promise<Point3[]>

    Points on wire

divideWiresByEqualDistanceToPoints

  • Divides OpenCascade wires to equal distance points

    group

    extract from wires

    shortname

    points by distance

    drawable

    true

    Parameters

    Returns Promise<Point3[]>

    Points on wire

divideWiresByParamsToPoints

  • Divides OpenCascade wires to points blindly following its parametric space

    group

    extract from wires

    shortname

    points by params

    drawable

    true

    Parameters

    Returns Promise<Point3[][]>

    Points on wire

endPointOnWire

  • Computes the end point on the wire at param 1

    group

    extract

    shortname

    end point

    drawable

    true

    Parameters

    Returns Promise<Point3>

    The length of the wire

getWire

getWireCenterOfMass

  • Get the wire center of mass point

    group

    get

    shortname

    center of mass

    drawable

    true

    Parameters

    Returns Promise<Point3>

    point

getWireLength

  • Gets the wire length

    group

    get

    shortname

    length

    drawable

    false

    Parameters

    Returns Promise<number>

    Length

getWires

  • Gets all the wires from the shape

    group

    get

    shortname

    wires

    drawable

    true

    Parameters

    Returns Promise<TopoDSWirePointer[]>

    OpenCascade wires

getWiresCentersOfMass

  • Get the wires centers of mass point

    group

    get

    shortname

    centers of mass

    drawable

    true

    Parameters

    Returns Promise<Point3[]>

    points

getWiresLengths

  • Gets the lengths of wires

    group

    get

    shortname

    lengths

    drawable

    false

    Parameters

    Returns Promise<number[]>

    Lengths

interpolatePoints

  • Creates OpenCascade BSpline wire from points. This method can be used to create nicely shaped (periodic) loops.

    group

    via points

    shortname

    interpolate

    drawable

    true

    Parameters

    • inputs: InterpolationDto

      Points through which to make the curve, periodic bool and tolerance

    Returns Promise<TopoDSWirePointer>

    OpenCascade BSpline wire

interpolateWires

  • Creates OpenCascade multiple interpolated wires

    group

    multiple

    shortname

    interpolate wires

    drawable

    true

    Parameters

    Returns Promise<TopoDSCompoundPointer | TopoDSWirePointer[]>

    OpenCascade BSpline wires

placeWireOnFace

  • Places a wire on the face by mapping it's 2d coordinates to UV space. Wire must be positioned on the ground XZ plane for this to work.

    group

    place

    shortname

    wire on face

    drawable

    true

    Parameters

    Returns Promise<TopoDSWirePointer>

    OpenCascade wire

placeWiresOnFace

  • Places multiple wires on the face by mapping it's 2d coordinates to UV space. Wires must be positioned on the ground XZ plane for this to work.

    group

    place

    shortname

    wires on face

    drawable

    true

    Parameters

    Returns Promise<TopoDSWirePointer[]>

    OpenCascade wires

pointOnWireAtLength

  • Evaluates point on a wire at certain length

    group

    extract

    shortname

    point at length

    drawable

    true

    Parameters

    Returns Promise<Point3>

    Point as array of 3 numbers

pointOnWireAtParam

  • Evaluates point on a wire at parameter value between 0 and 1, being start and end points

    group

    extract

    shortname

    point at param

    drawable

    true

    Parameters

    Returns Promise<Point3>

    Point as array of 3 numbers

project

projectWires

reversedWire

  • Computes reversed wire from input wire

    group

    get

    shortname

    reversed

    drawable

    true

    Parameters

    Returns Promise<TopoDSWirePointer>

    OpenCascade wire

reversedWireFromReversedEdges

  • Computes reversed wire by reversing all edges and combining them into a new wire

    group

    get

    shortname

    reversed wire by rev edges

    drawable

    true

    Parameters

    Returns Promise<TopoDSWirePointer>

    OpenCascade wire

splitOnPoints

  • Splits a wire on a set of given points

    group

    extract

    shortname

    split on points

    drawable

    true

    Parameters

    Returns Promise<TopoDSWirePointer[]>

    OpenCascade line wire shapes

startPointOnWire

  • Computes the start point on the wire at param 0

    group

    extract

    shortname

    start point

    drawable

    true

    Parameters

    Returns Promise<Point3>

    The length of the wire

tangentOnWireAtLength

  • Evaluates tangent vector on a wire at certain length

    group

    extract

    shortname

    tangent at length

    drawable

    true

    Parameters

    Returns Promise<Vector3>

    Tangent vector as array of 3 numbers

tangentOnWireAtParam

  • Evaluates tangent vector on a wire at parameter value between 0 and 1, being start and end points

    group

    extract

    shortname

    tangent at param

    drawable

    true

    Parameters

    Returns Promise<Vector3>

    Tangent vector as array of 3 numbers

wiresToPoints

  • Transform shape wires to points ordered in lists. This also removes duplicated points between start end end points of consecutive edges on the wire

    group

    extract

    shortname

    wires to points

    drawable

    false

    Parameters

    Returns Promise<Point3[][]>

    point lists for wires

Generated using TypeDoc