OCCT3D OCCT 8.0.1
OCCT documentation

Search guides and API reference

Enter at least two characters.

    Open CASCADE Technology Reference Manual 8.0.1
    TopoDS_Builder Class Reference

    A Builder is used to create Topological Data Structures. It is the root of the Builder class hierarchy. More...

    #include <TopoDS_Builder.hxx>

    Inheritance diagram for TopoDS_Builder:

    Public Member Functions

    void MakeWire (TopoDS_Wire &W) const
     Make an empty Wire.
    void MakeShell (TopoDS_Shell &S) const
     Make an empty Shell.
    void MakeSolid (TopoDS_Solid &S) const
     Make a Solid covering the whole 3D space.
    void MakeCompSolid (TopoDS_CompSolid &C) const
     Make an empty Composite Solid.
    void MakeCompound (TopoDS_Compound &C) const
     Make an empty Compound.
    void Add (TopoDS_Shape &S, const TopoDS_Shape &C) const
     Add the Shape C in the Shape S. Exceptions.
    void Remove (TopoDS_Shape &S, const TopoDS_Shape &C) const
     Remove the Shape C from the Shape S. Exceptions TopoDS_FrozenShape if S is frozen and cannot be modified.

    Protected Member Functions

    void MakeShape (TopoDS_Shape &S, const occ::handle< TopoDS_TShape > &T) const
     The basic method to make a Shape, used by all the Make methods.

    Detailed Description

    A Builder is used to create Topological Data Structures. It is the root of the Builder class hierarchy.

    There are three groups of methods in the Builder:

    The Make methods create Shapes.

    The Add method includes a Shape in another Shape.

    The Remove method removes a Shape from an other Shape.

    The methods in Builder are not static. They can be redefined in inherited builders.

    This Builder does not provide methods to Make Vertices, Edges, Faces, Shells or Solids. These methods are provided in the inherited Builders as they must provide the geometry.

    The Add method check for the following rules:

    • Any SHAPE can be added in a COMPOUND.
    • Only SOLID can be added in a COMPSOLID.
    • Only SHELL, EDGE and VERTEX can be added in a SOLID. EDGE and VERTEX as to be INTERNAL or EXTERNAL.
    • Only FACE can be added in a SHELL.
    • Only WIRE and VERTEX can be added in a FACE. VERTEX as to be INTERNAL or EXTERNAL.
    • Only EDGE can be added in a WIRE.
    • Only VERTEX can be added in an EDGE.
    • Nothing can be added in a VERTEX.

    Member Function Documentation

    ◆ Add()

    void TopoDS_Builder::Add ( TopoDS_Shape & S,
    const TopoDS_Shape & C ) const

    Add the Shape C in the Shape S. Exceptions.

    • TopoDS_FrozenShape if S is not free and cannot be modified.
    • TopoDS__UnCompatibleShapes if S and C are not compatible.

    ◆ MakeCompound()

    void TopoDS_Builder::MakeCompound ( TopoDS_Compound & C) const

    Make an empty Compound.

    ◆ MakeCompSolid()

    void TopoDS_Builder::MakeCompSolid ( TopoDS_CompSolid & C) const

    Make an empty Composite Solid.

    ◆ MakeShape()

    void TopoDS_Builder::MakeShape ( TopoDS_Shape & S,
    const occ::handle< TopoDS_TShape > & T ) const
    protected

    The basic method to make a Shape, used by all the Make methods.

    ◆ MakeShell()

    void TopoDS_Builder::MakeShell ( TopoDS_Shell & S) const

    Make an empty Shell.

    ◆ MakeSolid()

    void TopoDS_Builder::MakeSolid ( TopoDS_Solid & S) const

    Make a Solid covering the whole 3D space.

    ◆ MakeWire()

    void TopoDS_Builder::MakeWire ( TopoDS_Wire & W) const

    Make an empty Wire.

    ◆ Remove()

    void TopoDS_Builder::Remove ( TopoDS_Shape & S,
    const TopoDS_Shape & C ) const

    Remove the Shape C from the Shape S. Exceptions TopoDS_FrozenShape if S is frozen and cannot be modified.


    The documentation for this class was generated from the following file: