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

ModelingAlgorithms
TKShHealing
ShapeAnalysis


ShapeAnalysis_FreeBoundData Class Reference

This class is intended to represent free bound and to store
its properties.
.

#include <ShapeAnalysis_FreeBoundData.hxx>


Public Member Functions

Standard_EXPORT ShapeAnalysis_FreeBoundData ()
 Empty constructor
.
Standard_EXPORT ShapeAnalysis_FreeBoundData (const TopoDS_Wire &freebound)
 Creates object with contour given in the form of TopoDS_Wire
.
Standard_EXPORT void Clear ()
 Clears all properties of the contour.
Contour bound itself is not cleared.
.
void SetFreeBound (const TopoDS_Wire &freebound)
 Sets contour
.
void SetArea (const Standard_Real area)
 Sets area of the contour
.
void SetPerimeter (const Standard_Real perimeter)
 Sets perimeter of the contour
.
void SetRatio (const Standard_Real ratio)
 Sets ratio of average length to average width of the contour
.
void SetWidth (const Standard_Real width)
 Sets average width of the contour
.
Standard_EXPORT void AddNotch (const TopoDS_Wire &notch, const Standard_Real width)
 Adds notch on the contour with its maximum width
.
TopoDS_Wire FreeBound () const
 Returns contour
.
Standard_Real Area () const
 Returns area of the contour
.
Standard_Real Perimeter () const
 Returns perimeter of the contour
.
Standard_Real Ratio () const
 Returns ratio of average length to average width of the contour
.
Standard_Real Width () const
 Returns average width of the contour
.
Standard_Integer NbNotches () const
 Returns number of notches on the contour
.
Handle_TopTools_HSequenceOfShape Notches () const
 Returns sequence of notches on the contour
.
TopoDS_Wire Notch (const Standard_Integer index) const
 Returns notch on the contour
.
Standard_EXPORT Standard_Real NotchWidth (const Standard_Integer index) const
 Returns maximum width of notch specified by its rank number
on the contour
.
Standard_EXPORT Standard_Real NotchWidth (const TopoDS_Wire &notch) const
 Returns maximum width of notch specified as TopoDS_Wire
on the contour
.
Standard_EXPORT const Handle (Standard_Type)&DynamicType() const

Private Attributes

TopoDS_Wire myBound
Standard_Real myArea
Standard_Real myPerimeter
Standard_Real myRatio
Standard_Real myWidth
Handle_TopTools_HSequenceOfShape myNotches
ShapeAnalysis_DataMapOfShapeReal myNotchesParams


Constructor & Destructor Documentation

Standard_EXPORT ShapeAnalysis_FreeBoundData::ShapeAnalysis_FreeBoundData  ) 
 

Standard_EXPORT ShapeAnalysis_FreeBoundData::ShapeAnalysis_FreeBoundData const TopoDS_Wire &  freebound  ) 
 


Member Function Documentation

Standard_EXPORT void ShapeAnalysis_FreeBoundData::AddNotch const TopoDS_Wire &  notch,
const Standard_Real  width
 

Standard_Real ShapeAnalysis_FreeBoundData::Area  )  const [inline]
 

Standard_EXPORT void ShapeAnalysis_FreeBoundData::Clear  ) 
 

TopoDS_Wire ShapeAnalysis_FreeBoundData::FreeBound  )  const [inline]
 

Standard_EXPORT const ShapeAnalysis_FreeBoundData::Handle Standard_Type   )  const
 

Standard_Integer ShapeAnalysis_FreeBoundData::NbNotches  )  const [inline]
 

TopoDS_Wire ShapeAnalysis_FreeBoundData::Notch const Standard_Integer  index  )  const [inline]
 

Handle_TopTools_HSequenceOfShape ShapeAnalysis_FreeBoundData::Notches  )  const [inline]
 

Standard_EXPORT Standard_Real ShapeAnalysis_FreeBoundData::NotchWidth const TopoDS_Wire &  notch  )  const
 

Standard_EXPORT Standard_Real ShapeAnalysis_FreeBoundData::NotchWidth const Standard_Integer  index  )  const
 

Standard_Real ShapeAnalysis_FreeBoundData::Perimeter  )  const [inline]
 

Standard_Real ShapeAnalysis_FreeBoundData::Ratio  )  const [inline]
 

void ShapeAnalysis_FreeBoundData::SetArea const Standard_Real  area  )  [inline]
 

void ShapeAnalysis_FreeBoundData::SetFreeBound const TopoDS_Wire &  freebound  )  [inline]
 

void ShapeAnalysis_FreeBoundData::SetPerimeter const Standard_Real  perimeter  )  [inline]
 

void ShapeAnalysis_FreeBoundData::SetRatio const Standard_Real  ratio  )  [inline]
 

void ShapeAnalysis_FreeBoundData::SetWidth const Standard_Real  width  )  [inline]
 

Standard_Real ShapeAnalysis_FreeBoundData::Width  )  const [inline]
 


Field Documentation

Standard_Real ShapeAnalysis_FreeBoundData::myArea [private]
 

TopoDS_Wire ShapeAnalysis_FreeBoundData::myBound [private]
 

Handle_TopTools_HSequenceOfShape ShapeAnalysis_FreeBoundData::myNotches [private]
 

ShapeAnalysis_DataMapOfShapeReal ShapeAnalysis_FreeBoundData::myNotchesParams [private]
 

Standard_Real ShapeAnalysis_FreeBoundData::myPerimeter [private]
 

Standard_Real ShapeAnalysis_FreeBoundData::myRatio [private]
 

Standard_Real ShapeAnalysis_FreeBoundData::myWidth [private]
 


The documentation for this class was generated from the following files:
Generated on Mon Aug 25 13:42:33 2008 for OpenCASCADE by  doxygen 1.4.1