Open CASCADE Technology  7.3.1.dev
Public Member Functions | Protected Attributes
BOPDS_PaveBlock Class Reference

The class BOPDS_PaveBlock is to store the information about pave block on an edge. Two adjacent paves on edge make up pave block. More...

#include <BOPDS_PaveBlock.hxx>

Inheritance diagram for BOPDS_PaveBlock:
Inheritance graph
[legend]

Public Member Functions

 BOPDS_PaveBlock ()
 Empty contructor. More...
 
 BOPDS_PaveBlock (const Handle< NCollection_BaseAllocator > &theAllocator)
 Contructor <theAllocator> - the allocator to manage the memory. More...
 
void SetPave1 (const BOPDS_Pave &thePave)
 Modifier Sets the first pave <thePave> More...
 
const BOPDS_PavePave1 () const
 Selector Returns the first pave. More...
 
void SetPave2 (const BOPDS_Pave &thePave)
 Modifier Sets the second pave <thePave> More...
 
const BOPDS_PavePave2 () const
 Selector Returns the second pave. More...
 
void SetEdge (const Standard_Integer theEdge)
 Modifier Sets the index of edge of pave block <theEdge> More...
 
Standard_Integer Edge () const
 Selector Returns the index of edge of pave block. More...
 
Standard_Boolean HasEdge () const
 Query Returns true if the pave block has edge. More...
 
Standard_Boolean HasEdge (Standard_Integer &theEdge) const
 Query Returns true if the pave block has edge Returns the index of edge <theEdge> More...
 
void SetOriginalEdge (const Standard_Integer theEdge)
 Modifier Sets the index of original edge of the pave block <theEdge> More...
 
Standard_Integer OriginalEdge () const
 Selector Returns the index of original edge of pave block. More...
 
Standard_Boolean IsSplitEdge () const
 Query Returns true if the edge is equal to the original edge of the pave block. More...
 
void Range (Standard_Real &theT1, Standard_Real &theT2) const
 Selector Returns the parametric range <theT1,theT2> of the pave block. More...
 
Standard_Boolean HasSameBounds (const Handle< BOPDS_PaveBlock > &theOther) const
 Query Returns true if the pave block has pave indices that equal to the pave indices of the pave block <theOther> More...
 
void Indices (Standard_Integer &theIndex1, Standard_Integer &theIndex2) const
 Selector Returns the pave indices <theIndex1,theIndex2> of the pave block. More...
 
Standard_Boolean IsToUpdate () const
 Query Returns true if the pave block contains extra paves. More...
 
void AppendExtPave (const BOPDS_Pave &thePave)
 Modifier Appends extra paves <thePave> More...
 
void AppendExtPave1 (const BOPDS_Pave &thePave)
 Modifier Appends extra pave <thePave> More...
 
void RemoveExtPave (const Standard_Integer theVertNum)
 Modifier Removes a pave with the given vertex number from extra paves. More...
 
const BOPDS_ListOfPaveExtPaves () const
 Selector Returns the extra paves. More...
 
BOPDS_ListOfPaveChangeExtPaves ()
 Selector / Modifier Returns the extra paves. More...
 
void Update (BOPDS_ListOfPaveBlock &theLPB, const Standard_Boolean theFlag=Standard_True)
 Modifier Updates the pave block. The extra paves are used to create new pave blocks <theLPB>. <theFlag> - if true, the first pave and the second pave are used to produce new pave blocks. More...
 
Standard_Boolean ContainsParameter (const Standard_Real thePrm, const Standard_Real theTol, Standard_Integer &theInd) const
 Query Returns true if the extra paves contain the pave with given value of the parameter <thePrm> <theTol> - the value of the tolerance to compare <theInd> - index of the found pave. More...
 
void SetShrunkData (const Standard_Real theTS1, const Standard_Real theTS2, const Bnd_Box &theBox, const Standard_Boolean theIsSplittable)
 Modifier Sets the shrunk data for the pave block <theTS1>, <theTS2> - shrunk range <theBox> - the bounding box <theIsSplittable> - defines whether the edge can be split. More...
 
void ShrunkData (Standard_Real &theTS1, Standard_Real &theTS2, Bnd_Box &theBox, Standard_Boolean &theIsSplittable) const
 Selector Returns the shrunk data for the pave block <theTS1>, <theTS2> - shrunk range <theBox> - the bounding box <theIsSplittable> - defines whether the edge can be split. More...
 
Standard_Boolean HasShrunkData () const
 Query Returns true if the pave block contains the shrunk data. More...
 
void Dump () const
 
Standard_Boolean IsSplittable () const
 Query Returns FALSE if the pave block has a too short shrunk range and cannot be split, otherwise returns TRUE. More...
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor. More...
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing. More...
 
Standard_Transientoperator= (const Standard_Transient &)
 Assignment operator, needed to avoid copying reference counter. More...
 
virtual ~Standard_Transient ()
 Destructor must be virtual. More...
 
virtual void Delete () const
 Memory deallocator for transient classes. More...
 
virtual const opencascade::handle< Standard_Type > & DynamicType () const
 Returns a type descriptor about this object. More...
 
Standard_Boolean IsInstance (const opencascade::handle< Standard_Type > &theType) const
 Returns a true value if this is an instance of Type. More...
 
Standard_Boolean IsInstance (const Standard_CString theTypeName) const
 Returns a true value if this is an instance of TypeName. More...
 
Standard_Boolean 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. More...
 
Standard_Boolean IsKind (const Standard_CString 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. More...
 
Standard_TransientThis () 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. More...
 
Standard_Integer GetRefCount () const
 Get the reference counter of this object. More...
 
void IncrementRefCounter () const
 Increments the reference counter of this object. More...
 
Standard_Integer DecrementRefCounter () const
 Decrements the reference counter of this object; returns the decremented value. More...
 

Protected Attributes

Handle< NCollection_BaseAllocatormyAllocator
 
Standard_Integer myEdge
 
Standard_Integer myOriginalEdge
 
BOPDS_Pave myPave1
 
BOPDS_Pave myPave2
 
BOPDS_ListOfPave myExtPaves
 
Standard_Real myTS1
 
Standard_Real myTS2
 
Bnd_Box myShrunkBox
 
TColStd_MapOfInteger myMFence
 
Standard_Boolean myIsSplittable
 

Additional Inherited Members

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

Detailed Description

The class BOPDS_PaveBlock is to store the information about pave block on an edge. Two adjacent paves on edge make up pave block.

Constructor & Destructor Documentation

◆ BOPDS_PaveBlock() [1/2]

BOPDS_PaveBlock::BOPDS_PaveBlock ( )

Empty contructor.

◆ BOPDS_PaveBlock() [2/2]

BOPDS_PaveBlock::BOPDS_PaveBlock ( const Handle< NCollection_BaseAllocator > &  theAllocator)

Contructor <theAllocator> - the allocator to manage the memory.

Member Function Documentation

◆ AppendExtPave()

void BOPDS_PaveBlock::AppendExtPave ( const BOPDS_Pave thePave)

Modifier Appends extra paves <thePave>

◆ AppendExtPave1()

void BOPDS_PaveBlock::AppendExtPave1 ( const BOPDS_Pave thePave)

Modifier Appends extra pave <thePave>

◆ ChangeExtPaves()

BOPDS_ListOfPave& BOPDS_PaveBlock::ChangeExtPaves ( )

Selector / Modifier Returns the extra paves.

◆ ContainsParameter()

Standard_Boolean BOPDS_PaveBlock::ContainsParameter ( const Standard_Real  thePrm,
const Standard_Real  theTol,
Standard_Integer theInd 
) const

Query Returns true if the extra paves contain the pave with given value of the parameter <thePrm> <theTol> - the value of the tolerance to compare <theInd> - index of the found pave.

◆ Dump()

void BOPDS_PaveBlock::Dump ( ) const

◆ Edge()

Standard_Integer BOPDS_PaveBlock::Edge ( ) const

Selector Returns the index of edge of pave block.

◆ ExtPaves()

const BOPDS_ListOfPave& BOPDS_PaveBlock::ExtPaves ( ) const

Selector Returns the extra paves.

◆ HasEdge() [1/2]

Standard_Boolean BOPDS_PaveBlock::HasEdge ( ) const

Query Returns true if the pave block has edge.

◆ HasEdge() [2/2]

Standard_Boolean BOPDS_PaveBlock::HasEdge ( Standard_Integer theEdge) const

Query Returns true if the pave block has edge Returns the index of edge <theEdge>

◆ HasSameBounds()

Standard_Boolean BOPDS_PaveBlock::HasSameBounds ( const Handle< BOPDS_PaveBlock > &  theOther) const

Query Returns true if the pave block has pave indices that equal to the pave indices of the pave block <theOther>

◆ HasShrunkData()

Standard_Boolean BOPDS_PaveBlock::HasShrunkData ( ) const

Query Returns true if the pave block contains the shrunk data.

◆ Indices()

void BOPDS_PaveBlock::Indices ( Standard_Integer theIndex1,
Standard_Integer theIndex2 
) const

Selector Returns the pave indices <theIndex1,theIndex2> of the pave block.

◆ IsSplitEdge()

Standard_Boolean BOPDS_PaveBlock::IsSplitEdge ( ) const

Query Returns true if the edge is equal to the original edge of the pave block.

◆ IsSplittable()

Standard_Boolean BOPDS_PaveBlock::IsSplittable ( ) const
inline

Query Returns FALSE if the pave block has a too short shrunk range and cannot be split, otherwise returns TRUE.

◆ IsToUpdate()

Standard_Boolean BOPDS_PaveBlock::IsToUpdate ( ) const

Query Returns true if the pave block contains extra paves.

◆ OriginalEdge()

Standard_Integer BOPDS_PaveBlock::OriginalEdge ( ) const

Selector Returns the index of original edge of pave block.

◆ Pave1()

const BOPDS_Pave& BOPDS_PaveBlock::Pave1 ( ) const

Selector Returns the first pave.

◆ Pave2()

const BOPDS_Pave& BOPDS_PaveBlock::Pave2 ( ) const

Selector Returns the second pave.

◆ Range()

void BOPDS_PaveBlock::Range ( Standard_Real theT1,
Standard_Real theT2 
) const

Selector Returns the parametric range <theT1,theT2> of the pave block.

◆ RemoveExtPave()

void BOPDS_PaveBlock::RemoveExtPave ( const Standard_Integer  theVertNum)

Modifier Removes a pave with the given vertex number from extra paves.

◆ SetEdge()

void BOPDS_PaveBlock::SetEdge ( const Standard_Integer  theEdge)

Modifier Sets the index of edge of pave block <theEdge>

◆ SetOriginalEdge()

void BOPDS_PaveBlock::SetOriginalEdge ( const Standard_Integer  theEdge)

Modifier Sets the index of original edge of the pave block <theEdge>

◆ SetPave1()

void BOPDS_PaveBlock::SetPave1 ( const BOPDS_Pave thePave)

Modifier Sets the first pave <thePave>

◆ SetPave2()

void BOPDS_PaveBlock::SetPave2 ( const BOPDS_Pave thePave)

Modifier Sets the second pave <thePave>

◆ SetShrunkData()

void BOPDS_PaveBlock::SetShrunkData ( const Standard_Real  theTS1,
const Standard_Real  theTS2,
const Bnd_Box theBox,
const Standard_Boolean  theIsSplittable 
)

Modifier Sets the shrunk data for the pave block <theTS1>, <theTS2> - shrunk range <theBox> - the bounding box <theIsSplittable> - defines whether the edge can be split.

◆ ShrunkData()

void BOPDS_PaveBlock::ShrunkData ( Standard_Real theTS1,
Standard_Real theTS2,
Bnd_Box theBox,
Standard_Boolean theIsSplittable 
) const

Selector Returns the shrunk data for the pave block <theTS1>, <theTS2> - shrunk range <theBox> - the bounding box <theIsSplittable> - defines whether the edge can be split.

◆ Update()

void BOPDS_PaveBlock::Update ( BOPDS_ListOfPaveBlock theLPB,
const Standard_Boolean  theFlag = Standard_True 
)

Modifier Updates the pave block. The extra paves are used to create new pave blocks <theLPB>. <theFlag> - if true, the first pave and the second pave are used to produce new pave blocks.

Field Documentation

◆ myAllocator

Handle< NCollection_BaseAllocator > BOPDS_PaveBlock::myAllocator
protected

◆ myEdge

Standard_Integer BOPDS_PaveBlock::myEdge
protected

◆ myExtPaves

BOPDS_ListOfPave BOPDS_PaveBlock::myExtPaves
protected

◆ myIsSplittable

Standard_Boolean BOPDS_PaveBlock::myIsSplittable
protected

◆ myMFence

TColStd_MapOfInteger BOPDS_PaveBlock::myMFence
protected

◆ myOriginalEdge

Standard_Integer BOPDS_PaveBlock::myOriginalEdge
protected

◆ myPave1

BOPDS_Pave BOPDS_PaveBlock::myPave1
protected

◆ myPave2

BOPDS_Pave BOPDS_PaveBlock::myPave2
protected

◆ myShrunkBox

Bnd_Box BOPDS_PaveBlock::myShrunkBox
protected

◆ myTS1

Standard_Real BOPDS_PaveBlock::myTS1
protected

◆ myTS2

Standard_Real BOPDS_PaveBlock::myTS2
protected

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