ShapeAnalysis_FreeBoundData Class Reference

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

This class is used by ShapeAnalysis_FreeBoundsProperties
class when storing each free bound and its properties.

The properties stored in this class are the following:
More...

#include <ShapeAnalysis_FreeBoundData.hxx>

Inheritance diagram for ShapeAnalysis_FreeBoundData:

Public Member Functions
	ShapeAnalysis_FreeBoundData ()
	Empty constructor
	ShapeAnalysis_FreeBoundData (const TopoDS_Wire &freebound)
	Creates object with contour given in the form of TopoDS_Wire
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
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_Real	NotchWidth (const Standard_Integer index) const
	Returns maximum width of notch specified by its rank number on the contour
Standard_Real	NotchWidth (const TopoDS_Wire &notch) const
	Returns maximum width of notch specified as TopoDS_Wire on the contour

---

Detailed Description

     - area of the contour, <br>
     - perimeter of the contour, <br>
     - ratio of average length to average width of the contour, <br>
     - average width of contour, <br>
     - notches (narrow 'V'-like sub-contours) on the contour and <br>
       their maximum width. <br>

This class provides methods for setting and getting fields
only.

---

Constructor & Destructor Documentation

ShapeAnalysis_FreeBoundData::ShapeAnalysis_FreeBoundData

(

)

ShapeAnalysis_FreeBoundData::ShapeAnalysis_FreeBoundData

(

const TopoDS_Wire &

freebound

)

---

Member Function Documentation

void ShapeAnalysis_FreeBoundData::AddNotch	(	const TopoDS_Wire &	notch,
		const Standard_Real	width
	)

Standard_Real ShapeAnalysis_FreeBoundData::Area

(

)

const

void ShapeAnalysis_FreeBoundData::Clear

(

)

TopoDS_Wire ShapeAnalysis_FreeBoundData::FreeBound

(

)

const

Standard_Integer ShapeAnalysis_FreeBoundData::NbNotches

(

)

const

TopoDS_Wire ShapeAnalysis_FreeBoundData::Notch

(

const Standard_Integer

index

)

const

Handle_TopTools_HSequenceOfShape ShapeAnalysis_FreeBoundData::Notches

(

)

const

Standard_Real ShapeAnalysis_FreeBoundData::NotchWidth

(

const Standard_Integer

index

)

const

Standard_Real ShapeAnalysis_FreeBoundData::NotchWidth

(

const TopoDS_Wire &

notch

)

const

Standard_Real ShapeAnalysis_FreeBoundData::Perimeter

(

)

const

Standard_Real ShapeAnalysis_FreeBoundData::Ratio

(

)

const

void ShapeAnalysis_FreeBoundData::SetArea

(

const Standard_Real

area

)

void ShapeAnalysis_FreeBoundData::SetFreeBound

(

const TopoDS_Wire &

freebound

)

void ShapeAnalysis_FreeBoundData::SetPerimeter

(

const Standard_Real

perimeter

)

void ShapeAnalysis_FreeBoundData::SetRatio

(

const Standard_Real

ratio

)

void ShapeAnalysis_FreeBoundData::SetWidth

(

const Standard_Real

width

)

Standard_Real ShapeAnalysis_FreeBoundData::Width

(

)

const

---

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

• ShapeAnalysis_FreeBoundData.hxx