Open CASCADE Technology 7.8.0
Public Member Functions | Protected Attributes
BOPDS_ShapeInfo Class Reference

The class BOPDS_ShapeInfo is to store handy information about shape. More...

#include <BOPDS_ShapeInfo.hxx>

Public Member Functions

 BOPDS_ShapeInfo ()
 Empty constructor.
 
virtual ~BOPDS_ShapeInfo ()
 
 BOPDS_ShapeInfo (const Handle< NCollection_BaseAllocator > &theAllocator)
 Constructor.
 
void SetShape (const TopoDS_Shape &theS)
 Modifier Sets the shape <theS>
 
const TopoDS_ShapeShape () const
 Selector Returns the shape.
 
void SetShapeType (const TopAbs_ShapeEnum theType)
 Modifier Sets the type of shape theType.
 
TopAbs_ShapeEnum ShapeType () const
 Selector Returns the type of shape.
 
void SetBox (const Bnd_Box &theBox)
 Modifier Sets the boundung box of the shape theBox.
 
const Bnd_BoxBox () const
 Selector Returns the boundung box of the shape.
 
Bnd_BoxChangeBox ()
 Selector/Modifier Returns the boundung box of the shape.
 
const TColStd_ListOfIntegerSubShapes () const
 Selector Returns the list of indices of sub-shapes.
 
TColStd_ListOfIntegerChangeSubShapes ()
 Selector/ Modifier Returns the list of indices of sub-shapes.
 
Standard_Boolean HasSubShape (const Standard_Integer theI) const
 Query Returns true if the shape has sub-shape with index theI.
 
Standard_Boolean HasReference () const
 
void SetReference (const Standard_Integer theI)
 Modifier Sets the index of a reference information.
 
Standard_Integer Reference () const
 Selector Returns the index of a reference information.
 
Standard_Boolean HasBRep () const
 Query Returns true if the shape has boundary representation.
 
Standard_Boolean IsInterfering () const
 Returns true if the shape can be participant of an interference.
 
Standard_Boolean HasFlag () const
 Query Returns true if there is flag.
 
Standard_Boolean HasFlag (Standard_Integer &theFlag) const
 Query Returns true if there is flag. Returns the flag theFlag.
 
void SetFlag (const Standard_Integer theI)
 Modifier Sets the flag.
 
Standard_Integer Flag () const
 Returns the flag.
 
void Dump () const
 

Protected Attributes

TopoDS_Shape myShape
 
TopAbs_ShapeEnum myType
 
Bnd_Box myBox
 
TColStd_ListOfInteger mySubShapes
 
Standard_Integer myReference
 
Standard_Integer myFlag
 

Detailed Description

The class BOPDS_ShapeInfo is to store handy information about shape.

Constructor & Destructor Documentation

◆ BOPDS_ShapeInfo() [1/2]

BOPDS_ShapeInfo::BOPDS_ShapeInfo ( )

Empty constructor.

◆ ~BOPDS_ShapeInfo()

virtual BOPDS_ShapeInfo::~BOPDS_ShapeInfo ( )
virtual

◆ BOPDS_ShapeInfo() [2/2]

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

Constructor.

Parameters
theAllocatorthe allocator to manage the memory

Member Function Documentation

◆ Box()

const Bnd_Box & BOPDS_ShapeInfo::Box ( ) const

Selector Returns the boundung box of the shape.

◆ ChangeBox()

Bnd_Box & BOPDS_ShapeInfo::ChangeBox ( )

Selector/Modifier Returns the boundung box of the shape.

◆ ChangeSubShapes()

TColStd_ListOfInteger & BOPDS_ShapeInfo::ChangeSubShapes ( )

Selector/ Modifier Returns the list of indices of sub-shapes.

◆ Dump()

void BOPDS_ShapeInfo::Dump ( ) const

◆ Flag()

Standard_Integer BOPDS_ShapeInfo::Flag ( ) const

Returns the flag.

◆ HasBRep()

Standard_Boolean BOPDS_ShapeInfo::HasBRep ( ) const

Query Returns true if the shape has boundary representation.

◆ HasFlag() [1/2]

Standard_Boolean BOPDS_ShapeInfo::HasFlag ( ) const

Query Returns true if there is flag.

◆ HasFlag() [2/2]

Standard_Boolean BOPDS_ShapeInfo::HasFlag ( Standard_Integer theFlag) const

Query Returns true if there is flag. Returns the flag theFlag.

◆ HasReference()

Standard_Boolean BOPDS_ShapeInfo::HasReference ( ) const

◆ HasSubShape()

Standard_Boolean BOPDS_ShapeInfo::HasSubShape ( const Standard_Integer  theI) const

Query Returns true if the shape has sub-shape with index theI.

◆ IsInterfering()

Standard_Boolean BOPDS_ShapeInfo::IsInterfering ( ) const

Returns true if the shape can be participant of an interference.

Flag

◆ Reference()

Standard_Integer BOPDS_ShapeInfo::Reference ( ) const

Selector Returns the index of a reference information.

◆ SetBox()

void BOPDS_ShapeInfo::SetBox ( const Bnd_Box theBox)

Modifier Sets the boundung box of the shape theBox.

◆ SetFlag()

void BOPDS_ShapeInfo::SetFlag ( const Standard_Integer  theI)

Modifier Sets the flag.

◆ SetReference()

void BOPDS_ShapeInfo::SetReference ( const Standard_Integer  theI)

Modifier Sets the index of a reference information.

◆ SetShape()

void BOPDS_ShapeInfo::SetShape ( const TopoDS_Shape theS)

Modifier Sets the shape <theS>

◆ SetShapeType()

void BOPDS_ShapeInfo::SetShapeType ( const TopAbs_ShapeEnum  theType)

Modifier Sets the type of shape theType.

◆ Shape()

const TopoDS_Shape & BOPDS_ShapeInfo::Shape ( ) const

Selector Returns the shape.

◆ ShapeType()

TopAbs_ShapeEnum BOPDS_ShapeInfo::ShapeType ( ) const

Selector Returns the type of shape.

◆ SubShapes()

const TColStd_ListOfInteger & BOPDS_ShapeInfo::SubShapes ( ) const

Selector Returns the list of indices of sub-shapes.

Field Documentation

◆ myBox

Bnd_Box BOPDS_ShapeInfo::myBox
protected

◆ myFlag

Standard_Integer BOPDS_ShapeInfo::myFlag
protected

◆ myReference

Standard_Integer BOPDS_ShapeInfo::myReference
protected

◆ myShape

TopoDS_Shape BOPDS_ShapeInfo::myShape
protected

◆ mySubShapes

TColStd_ListOfInteger BOPDS_ShapeInfo::mySubShapes
protected

◆ myType

TopAbs_ShapeEnum BOPDS_ShapeInfo::myType
protected

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