OCC Main Page | ModelingData | Toolkits | Packages | Class Hierarchy | Data Structures | File List | Data Fields | Globals

ModelingData
TKGeomBase
GC


GC_MakeTrimmedCylinder Class Reference

Implements construction algorithms for a trimmed
cylinder limited by two planes orthogonal to its axis.
The result is a Geom_RectangularTrimmedSurface surface.
A MakeTrimmedCylinder provides a framework for:
- defining the construction of the trimmed cylinder,
- implementing the construction algorithm, and
- consulting the results. In particular, the Value
function returns the constructed trimmed cylinder.
.

#include <GC_MakeTrimmedCylinder.hxx>

Inheritance diagram for GC_MakeTrimmedCylinder:

Inheritance graph
[legend]

Public Member Functions

void * operator new (size_t, void *anAddress)
void * operator new (size_t size)
void operator delete (void *anAddress)
Standard_EXPORT GC_MakeTrimmedCylinder (const gp_Pnt &P1, const gp_Pnt &P2, const gp_Pnt &P3)
 Make a cylindricalSurface <cyl> from Geom
Its axis is is <p1p2> and its radius is the distance
between <p3> and <p1p2>.
The height is the distance between P1 and P2.
.
Standard_EXPORT GC_MakeTrimmedCylinder (const gp_Circ &Circ, const Standard_Real Height)
 Make a cylindricalSurface <cyl> from gp by its base <circ>.
Its axis is the normal to the plane defined bi <circ>.
<height> can be greater than zero or lower than zero.
In the first case the V parametric direction of the
result has the same orientation as the normal to <circ>.
In the other case it has the opposite orientation.
.
Standard_EXPORT GC_MakeTrimmedCylinder (const gp_Ax1 &A1, const Standard_Real Radius, const Standard_Real Height)
 Make a cylindricalSurface <cyl> from gp by its
axis <a1> and its radius <radius>.
It returns NullObject if <radius> is lower than zero.
<height> can be greater than zero or lower than zero.
In the first case the V parametric direction of the
result has the same orientation as <a1>.
In the other case it has the opposite orientation.
.
Standard_EXPORT GC_MakeTrimmedCylinder (const gp_Cylinder &Cyl, const gp_Pnt &P, const Standard_Real Height)
 Make a RectangularTrimmedSurface <cylinder> from gp by
a cylinder from gp.
It is trimmed by the point

and the heigh <heigh>.
<height> can be greater than zero or lower than zero.
in the first case the limit section is in the side of
the positives V paramters of <cyl> and in the other
side if <heigh> is lower than zero.
.

Standard_EXPORT GC_MakeTrimmedCylinder (const gp_Cylinder &Cyl, const gp_Pnt &P1, const gp_Pnt &P2)
 Make a RectangularTrimmedSurface <cylinder> from gp by
a cylinder from gp.
It is trimmed by the two points <p1> and <p2>.
Warning
If an error occurs (that is, when IsDone returns
false), the Status function returns:
- gce_NegativeRadius if Radius is less than 0.0, or
- gce_ConfusedPoints if the points P1 and P2 are coincident.
- gce_ColinearPoints if the points P1, P2 and P3 are collinear.
.
Standard_EXPORT const Handle_Geom_RectangularTrimmedSurface & Value () const
 Returns the constructed trimmed cylinder.
Exceptions
StdFail_NotDone if no trimmed cylinder is constructed.
.
Standard_EXPORT const Handle_Geom_RectangularTrimmedSurface & Operator () const
Standard_EXPORT operator Handle_Geom_RectangularTrimmedSurface () const

Private Attributes

Handle_Geom_RectangularTrimmedSurface TheCyl

Constructor & Destructor Documentation

Standard_EXPORT GC_MakeTrimmedCylinder::GC_MakeTrimmedCylinder const gp_Pnt &  P1,
const gp_Pnt &  P2,
const gp_Pnt &  P3
 

Standard_EXPORT GC_MakeTrimmedCylinder::GC_MakeTrimmedCylinder const gp_Circ &  Circ,
const Standard_Real  Height
 

Standard_EXPORT GC_MakeTrimmedCylinder::GC_MakeTrimmedCylinder const gp_Ax1 &  A1,
const Standard_Real  Radius,
const Standard_Real  Height
 

Standard_EXPORT GC_MakeTrimmedCylinder::GC_MakeTrimmedCylinder const gp_Cylinder &  Cyl,
const gp_Pnt &  P,
const Standard_Real  Height
 

Standard_EXPORT GC_MakeTrimmedCylinder::GC_MakeTrimmedCylinder const gp_Cylinder &  Cyl,
const gp_Pnt &  P1,
const gp_Pnt &  P2
 


Member Function Documentation

Standard_EXPORT const Handle_Geom_RectangularTrimmedSurface& GC_MakeTrimmedCylinder::Operator  )  const
 

void GC_MakeTrimmedCylinder::operator delete void *  anAddress  )  [inline]
 

Reimplemented from GC_Root.

Standard_EXPORT GC_MakeTrimmedCylinder::operator Handle_Geom_RectangularTrimmedSurface  )  const
 

void* GC_MakeTrimmedCylinder::operator new size_t  size  )  [inline]
 

Reimplemented from GC_Root.

void* GC_MakeTrimmedCylinder::operator new size_t  ,
void *  anAddress
[inline]
 

Reimplemented from GC_Root.

Standard_EXPORT const Handle_Geom_RectangularTrimmedSurface& GC_MakeTrimmedCylinder::Value  )  const
 


Field Documentation

Handle_Geom_RectangularTrimmedSurface GC_MakeTrimmedCylinder::TheCyl [private]
 


The documentation for this class was generated from the following file:
Generated on Mon Aug 25 13:22:41 2008 for OpenCASCADE by  doxygen 1.4.1