OCCT 8.0.1
OCCT documentation

Search guides and API reference

Enter at least two characters.

    Open CASCADE Technology Reference Manual 8.0.1
    BRepPrim_Cylinder Class Reference

    Cylinder primitive. More...

    #include <BRepPrim_Cylinder.hxx>

    Inheritance diagram for BRepPrim_Cylinder:

    Public Member Functions

     BRepPrim_Cylinder (const gp_Ax2 &Position, const double Radius, const double Height)
     the STEP definition Position : center of a Face and Axis Radius : radius of cylinder Height : distance between faces on positive side
     BRepPrim_Cylinder (const double Radius)
     infinite Cylinder at origin on Z negative
     BRepPrim_Cylinder (const gp_Pnt &Center, const double Radius)
     infinite Cylinder at Center on Z negative
     BRepPrim_Cylinder (const gp_Ax2 &Axes, const double Radius)
     infinite Cylinder at Axes on Z negative
     BRepPrim_Cylinder (const double R, const double H)
     create a Cylinder at origin on Z axis, of height H and radius R Error : Radius < Resolution H < Resolution H negative
     BRepPrim_Cylinder (const gp_Pnt &Center, const double R, const double H)
     same as above but at a given point
    TopoDS_Face MakeEmptyLateralFace () const override
     The surface normal should be directed towards the outside.
    Public Member Functions inherited from BRepPrim_Revolution
     BRepPrim_Revolution (const gp_Ax2 &A, const double VMin, const double VMax, const occ::handle< Geom_Curve > &M, const occ::handle< Geom2d_Curve > &PM)
     Create a revolution body <M> is the meridian nd must be in the XZ plane of . <PM> is the meridian in the XZ plane.
    TopoDS_Face MakeEmptyLateralFace () const override
     The surface normal should be directed towards the outside.
    TopoDS_Edge MakeEmptyMeridianEdge (const double Ang) const override
     Returns an edge with a 3D curve made from the meridian in the XZ plane rotated by <Ang> around the Z-axis. Ang may be 0 or myAngle.
    gp_Pnt2d MeridianValue (const double V) const override
     Returns the meridian point at parameter <V> in the plane XZ.
    void SetMeridianPCurve (TopoDS_Edge &E, const TopoDS_Face &F) const override
     Sets the parametric urve of the edge <E> in the face <F> to be the 2d representation of the meridian.
    Public Member Functions inherited from BRepPrim_OneAxis
    void SetMeridianOffset (const double MeridianOffset=0)
     The MeridianOffset is added to the parameters on the meridian curve and to the V values of the pcurves. This is used for the sphere for example, to give a range on the meridian edge which is not VMin, VMax.
    const gp_Ax2 & Axes () const
     Returns the Ax2 from <me>.
    void Axes (const gp_Ax2 &A)
    double Angle () const
    void Angle (const double A)
    double VMin () const
    void VMin (const double V)
    double VMax () const
    void VMax (const double V)
    virtual bool MeridianOnAxis (const double V) const
     Returns True if the point of parameter <V> on the meridian is on the Axis. Default implementation is std::abs(MeridianValue(V).X()) < Precision::Confusion().
    virtual bool MeridianClosed () const
     Returns True if the meridian is closed. Default implementation is: MeridianValue(VMin).IsEqual(MeridianValue(VMax), Precision::Confusion()).
    virtual bool VMaxInfinite () const
     Returns True if VMax is infinite. Default Precision::IsPositiveInfinite(VMax);.
    virtual bool VMinInfinite () const
     Returns True if VMin is infinite. Default Precision::IsNegativeInfinite(VMax);.
    virtual bool HasTop () const
     Returns True if there is a top face.
    virtual bool HasBottom () const
     Returns True if there is a bottom face.
    virtual bool HasSides () const
     Returns True if there are Start and End faces.
    const TopoDS_Shell & Shell ()
     Returns the Shell containing all the Faces of the primitive.
    const TopoDS_Face & LateralFace ()
     Returns the lateral Face. It is oriented toward the outside of the primitive.
    const TopoDS_Face & TopFace ()
     Returns the top planar Face. It is Oriented toward the +Z axis (outside).
    const TopoDS_Face & BottomFace ()
     Returns the Bottom planar Face. It is Oriented toward the -Z axis (outside).
    const TopoDS_Face & StartFace ()
     Returns the Face starting the slice, it is oriented toward the exterior of the primitive.
    const TopoDS_Face & EndFace ()
     Returns the Face ending the slice, it is oriented toward the exterior of the primitive.
    const TopoDS_Wire & LateralWire ()
     Returns the wire in the lateral face.
    const TopoDS_Wire & LateralStartWire ()
     Returns the wire in the lateral face with the start edge.
    const TopoDS_Wire & LateralEndWire ()
     Returns the wire with in lateral face with the end edge.
    const TopoDS_Wire & TopWire ()
     Returns the wire in the top face.
    const TopoDS_Wire & BottomWire ()
     Returns the wire in the bottom face.
    const TopoDS_Wire & StartWire ()
     Returns the wire in the start face.
    const TopoDS_Wire & AxisStartWire ()
     Returns the wire in the start face with the AxisEdge.
    const TopoDS_Wire & EndWire ()
     Returns the Wire in the end face.
    const TopoDS_Wire & AxisEndWire ()
     Returns the Wire in the end face with the AxisEdge.
    const TopoDS_Edge & AxisEdge ()
     Returns the Edge built along the Axis and oriented on +Z of the Axis.
    const TopoDS_Edge & StartEdge ()
     Returns the Edge at angle 0.
    const TopoDS_Edge & EndEdge ()
     Returns the Edge at angle Angle. If !HasSides() the StartEdge and the EndEdge are the same edge.
    const TopoDS_Edge & StartTopEdge ()
     Returns the linear Edge between start Face and top Face.
    const TopoDS_Edge & StartBottomEdge ()
     Returns the linear Edge between start Face and bottom Face.
    const TopoDS_Edge & EndTopEdge ()
     Returns the linear Edge between end Face and top Face.
    const TopoDS_Edge & EndBottomEdge ()
     Returns the linear Edge between end Face and bottom Face.
    const TopoDS_Edge & TopEdge ()
     Returns the edge at VMax. If MeridianClosed() the TopEdge and the BottomEdge are the same edge.
    const TopoDS_Edge & BottomEdge ()
     Returns the edge at VMin. If MeridianClosed() the TopEdge and the BottomEdge are the same edge.
    const TopoDS_Vertex & AxisTopVertex ()
     Returns the Vertex at the Top altitude on the axis.
    const TopoDS_Vertex & AxisBottomVertex ()
     Returns the Vertex at the Bottom altitude on the axis.
    const TopoDS_Vertex & TopStartVertex ()
     Returns the vertex (0,VMax).
    const TopoDS_Vertex & TopEndVertex ()
     Returns the vertex (angle,VMax).
    const TopoDS_Vertex & BottomStartVertex ()
     Returns the vertex (0,VMin).
    const TopoDS_Vertex & BottomEndVertex ()
     Returns the vertex (angle,VMax).
    virtual ~BRepPrim_OneAxis ()

    Additional Inherited Members

    Protected Member Functions inherited from BRepPrim_Revolution
     BRepPrim_Revolution (const gp_Ax2 &A, const double VMin, const double VMax)
     Create a revolution body. The meridian is set later. Reserved for derivated classes.
    void Meridian (const occ::handle< Geom_Curve > &M, const occ::handle< Geom2d_Curve > &PM)
    Protected Member Functions inherited from BRepPrim_OneAxis
     BRepPrim_OneAxis (const BRepPrim_Builder &B, const gp_Ax2 &A, const double VMin, const double VMax)
     Creates a OneAxis algorithm. is used to build the Topology. The angle defaults to 2*PI.
    Protected Attributes inherited from BRepPrim_OneAxis
    BRepPrim_Builder myBuilder

    Detailed Description

    Cylinder primitive.

    Constructor & Destructor Documentation

    ◆ BRepPrim_Cylinder() [1/6]

    BRepPrim_Cylinder::BRepPrim_Cylinder ( const gp_Ax2 & Position,
    const double Radius,
    const double Height )

    the STEP definition Position : center of a Face and Axis Radius : radius of cylinder Height : distance between faces on positive side

    Errors : Height < Resolution Radius < Resolution

    ◆ BRepPrim_Cylinder() [2/6]

    BRepPrim_Cylinder::BRepPrim_Cylinder ( const double Radius)

    infinite Cylinder at origin on Z negative

    ◆ BRepPrim_Cylinder() [3/6]

    BRepPrim_Cylinder::BRepPrim_Cylinder ( const gp_Pnt & Center,
    const double Radius )

    infinite Cylinder at Center on Z negative

    ◆ BRepPrim_Cylinder() [4/6]

    BRepPrim_Cylinder::BRepPrim_Cylinder ( const gp_Ax2 & Axes,
    const double Radius )

    infinite Cylinder at Axes on Z negative

    ◆ BRepPrim_Cylinder() [5/6]

    BRepPrim_Cylinder::BRepPrim_Cylinder ( const double R,
    const double H )

    create a Cylinder at origin on Z axis, of height H and radius R Error : Radius < Resolution H < Resolution H negative

    ◆ BRepPrim_Cylinder() [6/6]

    BRepPrim_Cylinder::BRepPrim_Cylinder ( const gp_Pnt & Center,
    const double R,
    const double H )

    same as above but at a given point

    Member Function Documentation

    ◆ MakeEmptyLateralFace()

    TopoDS_Face BRepPrim_Cylinder::MakeEmptyLateralFace ( ) const
    overridevirtual

    The surface normal should be directed towards the outside.

    Implements BRepPrim_OneAxis.


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