Contap_TheIWLineOfTheIWalking Class Reference

#include <Contap_TheIWLineOfTheIWalking.hxx>

Inheritance diagram for Contap_TheIWLineOfTheIWalking:

Public Member Functions
	Contap_TheIWLineOfTheIWalking (const IntSurf_Allocator &theAllocator=nullptr)
void	Reverse ()
	reverse the points in the line. Hasfirst, HasLast are kept.
void	Cut (const int Index)
	Cut the line at the point of rank Index.
void	AddPoint (const IntSurf_PntOn2S &P)
	Add a point in the line.
void	AddStatusFirst (const bool Closed, const bool HasFirst)
void	AddStatusFirst (const bool Closed, const bool HasLast, const int Index, const IntSurf_PathPoint &P)
void	AddStatusFirstLast (const bool Closed, const bool HasFirst, const bool HasLast)
void	AddStatusLast (const bool HasLast)
void	AddStatusLast (const bool HasLast, const int Index, const IntSurf_PathPoint &P)
void	AddIndexPassing (const int Index)
	associate the index of the point on the line with the index of the point passing through the starting iterator
void	SetTangentVector (const gp_Vec &V, const int Index)
void	SetTangencyAtBegining (const bool IsTangent)
void	SetTangencyAtEnd (const bool IsTangent)
int	NbPoints () const
	Returns the number of points of the line (including first point and end point : see HasLastPoint and HasFirstPoint).
const IntSurf_PntOn2S &	Value (const int Index) const
	Returns the point of range Index. If index <= 0 or Index > NbPoints, an exception is raised.
const occ::handle< IntSurf_LineOn2S > &	Line () const
	Returns the LineOn2S contained in the walking line.
bool	IsClosed () const
	Returns True if the line is closed.
bool	HasFirstPoint () const
	Returns True if the first point of the line is a marching point. when is HasFirstPoint==False ,the line begins on the natural bound of the surface. The line can be too long.
bool	HasLastPoint () const
	Returns True if the end point of the line is a marching point (Point from IntWS). when is HasFirstPoint==False the line ends on the natural bound of the surface. The line can be too long.
const IntSurf_PathPoint &	FirstPoint () const
	Returns the first point of the line when it is a marching point. An exception is raised if HasFirstPoint returns False.
int	FirstPointIndex () const
	Returns the Index of first point of the line when it is a marching point. This index is the index in the PointStartIterator. An exception is raised if HasFirstPoint returns False.
const IntSurf_PathPoint &	LastPoint () const
	Returns the last point of the line when it is a marching point. An exception is raised if HasLastPoint returns False.
int	LastPointIndex () const
	Returns the index of last point of the line when it is a marching point. This index is the index in the PointStartIterator. An exception is raised if HasLastPoint returns False.
int	NbPassingPoint () const
	returns the number of points belonging to Pnts1 which are passing point.
void	PassingPoint (const int Index, int &IndexLine, int &IndexPnts) const
	returns the index of the point belonging to the line which is associated to the passing point belonging to Pnts1 an exception is raised if Index > NbPassingPoint()
const gp_Vec &	TangentVector (int &Index) const
bool	IsTangentAtBegining () const
bool	IsTangentAtEnd () const
Public Member Functions inherited from Standard_Transient
	Standard_Transient ()
	Empty constructor.
	Standard_Transient (const Standard_Transient &)
	Copy constructor – does nothing.
Standard_Transient &	operator= (const Standard_Transient &)
	Assignment operator, needed to avoid copying reference counter.
virtual	~Standard_Transient ()=default
	Destructor must be virtual.
virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.
bool	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.
bool	IsInstance (const char *const theTypeName) const
	Returns a true value if this is an instance of TypeName.
bool	IsKind (const opencascade::handle< Standard_Type > &theType) const
	Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
bool	IsKind (const char *const theTypeName) const
	Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
Standard_Transient *	This () const
	Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero.
int	GetRefCount () const noexcept
	Get the reference counter of this object.
void	IncrementRefCounter () noexcept
	Increments the reference counter of this object. Uses relaxed memory ordering since incrementing only requires atomicity, not synchronization with other memory operations.
int	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value. Uses release ordering for the decrement to ensure all writes to the object are visible before the count reaches zero. An acquire fence is added only when the count reaches zero, ensuring proper synchronization before deletion. This is more efficient than using acq_rel for every decrement.
virtual void	Delete () const
	Memory deallocator for transient classes.

Additional Inherited Members
Public Types inherited from Standard_Transient
typedef void	base_type
	Returns a type descriptor about this object.
Static Public Member Functions inherited from Standard_Transient
static constexpr const char *	get_type_name ()
	Returns a type descriptor about this object.
static const opencascade::handle< Standard_Type > &	get_type_descriptor ()
	Returns type descriptor of Standard_Transient class.

Constructor & Destructor Documentation

Contap_TheIWLineOfTheIWalking()

Contap_TheIWLineOfTheIWalking::Contap_TheIWLineOfTheIWalking

(

const IntSurf_Allocator &

theAllocator = nullptr

)

Member Function Documentation

AddIndexPassing()

void Contap_TheIWLineOfTheIWalking::AddIndexPassing ( const int Index )

inline

associate the index of the point on the line with the index of the point passing through the starting iterator

AddPoint()

void Contap_TheIWLineOfTheIWalking::AddPoint ( const IntSurf_PntOn2S & P )

inline

Add a point in the line.

AddStatusFirst() [1/2]

void Contap_TheIWLineOfTheIWalking::AddStatusFirst ( const bool Closed, const bool HasFirst )

inline

AddStatusFirst() [2/2]

void Contap_TheIWLineOfTheIWalking::AddStatusFirst ( const bool Closed, const bool HasLast, const int Index, const IntSurf_PathPoint & P )

inline

AddStatusFirstLast()

void Contap_TheIWLineOfTheIWalking::AddStatusFirstLast ( const bool Closed, const bool HasFirst, const bool HasLast )

inline

AddStatusLast() [1/2]

void Contap_TheIWLineOfTheIWalking::AddStatusLast ( const bool HasLast )

inline

AddStatusLast() [2/2]

void Contap_TheIWLineOfTheIWalking::AddStatusLast ( const bool HasLast, const int Index, const IntSurf_PathPoint & P )

inline

Cut()

void Contap_TheIWLineOfTheIWalking::Cut ( const int Index )

inline

Cut the line at the point of rank Index.

FirstPoint()

const IntSurf_PathPoint & Contap_TheIWLineOfTheIWalking::FirstPoint ( ) const

inline

Returns the first point of the line when it is a marching point. An exception is raised if HasFirstPoint returns False.

FirstPointIndex()

int Contap_TheIWLineOfTheIWalking::FirstPointIndex ( ) const

inline

Returns the Index of first point of the line when it is a marching point. This index is the index in the PointStartIterator. An exception is raised if HasFirstPoint returns False.

HasFirstPoint()

bool Contap_TheIWLineOfTheIWalking::HasFirstPoint ( ) const

inline

Returns True if the first point of the line is a marching point. when is HasFirstPoint==False ,the line begins on the natural bound of the surface. The line can be too long.

HasLastPoint()

bool Contap_TheIWLineOfTheIWalking::HasLastPoint ( ) const

inline

Returns True if the end point of the line is a marching point (Point from IntWS). when is HasFirstPoint==False the line ends on the natural bound of the surface. The line can be too long.

IsClosed()

bool Contap_TheIWLineOfTheIWalking::IsClosed ( ) const

inline

Returns True if the line is closed.

IsTangentAtBegining()

bool Contap_TheIWLineOfTheIWalking::IsTangentAtBegining ( ) const

inline

IsTangentAtEnd()

bool Contap_TheIWLineOfTheIWalking::IsTangentAtEnd ( ) const

inline

LastPoint()

const IntSurf_PathPoint & Contap_TheIWLineOfTheIWalking::LastPoint ( ) const

inline

Returns the last point of the line when it is a marching point. An exception is raised if HasLastPoint returns False.

LastPointIndex()

int Contap_TheIWLineOfTheIWalking::LastPointIndex ( ) const

inline

Returns the index of last point of the line when it is a marching point. This index is the index in the PointStartIterator. An exception is raised if HasLastPoint returns False.

Line()

const occ::handle< IntSurf_LineOn2S > & Contap_TheIWLineOfTheIWalking::Line ( ) const

inline

Returns the LineOn2S contained in the walking line.

NbPassingPoint()

int Contap_TheIWLineOfTheIWalking::NbPassingPoint ( ) const

inline

returns the number of points belonging to Pnts1 which are passing point.

NbPoints()

int Contap_TheIWLineOfTheIWalking::NbPoints ( ) const

inline

Returns the number of points of the line (including first point and end point : see HasLastPoint and HasFirstPoint).

PassingPoint()

void Contap_TheIWLineOfTheIWalking::PassingPoint ( const int Index, int & IndexLine, int & IndexPnts ) const

inline

returns the index of the point belonging to the line which is associated to the passing point belonging to Pnts1 an exception is raised if Index > NbPassingPoint()

Reverse()

void Contap_TheIWLineOfTheIWalking::Reverse

(

)

reverse the points in the line. Hasfirst, HasLast are kept.

SetTangencyAtBegining()

void Contap_TheIWLineOfTheIWalking::SetTangencyAtBegining ( const bool IsTangent )

inline

SetTangencyAtEnd()

void Contap_TheIWLineOfTheIWalking::SetTangencyAtEnd ( const bool IsTangent )

inline

SetTangentVector()

void Contap_TheIWLineOfTheIWalking::SetTangentVector ( const gp_Vec & V, const int Index )

inline

TangentVector()

const gp_Vec & Contap_TheIWLineOfTheIWalking::TangentVector ( int & Index ) const

inline

Value()

const IntSurf_PntOn2S & Contap_TheIWLineOfTheIWalking::Value ( const int Index ) const

inline

Returns the point of range Index. If index <= 0 or Index > NbPoints, an exception is raised.

---

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

• Contap_TheIWLineOfTheIWalking.hxx