OCCT3D OCCT 8.0.1
OCCT documentation

Search guides and API reference

Enter at least two characters.

    Open CASCADE Technology Reference Manual 8.0.1
    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 occ::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 NCollection_List< int > & SubShapes () const
     Selector Returns the list of indices of sub-shapes.
    NCollection_List< int > & ChangeSubShapes ()
     Selector/ Modifier Returns the list of indices of sub-shapes.
    bool HasSubShape (const int theI) const
     Query Returns true if the shape has sub-shape with index theI.
    bool HasReference () const
    void SetReference (const int theI)
     Modifier Sets the index of a reference information.
    int Reference () const
     Selector Returns the index of a reference information.
    bool HasBRep () const
     Query Returns true if the shape has boundary representation.
    bool IsInterfering () const
     Returns true if the shape can be participant of an interference.
    bool HasFlag () const
     Query Returns true if there is flag.
    bool HasFlag (int &theFlag) const
     Query Returns true if there is flag. Returns the flag theFlag.
    void SetFlag (const int theI)
     Modifier Sets the flag.
    int Flag () const
     Returns the flag.
    void Dump () const

    Protected Attributes

    TopoDS_Shape myShape
    TopAbs_ShapeEnum myType
    Bnd_Box myBox
    NCollection_List< int > mySubShapes
    int myReference
    int 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 occ::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()

    NCollection_List< int > & BOPDS_ShapeInfo::ChangeSubShapes ( )

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

    ◆ Dump()

    void BOPDS_ShapeInfo::Dump ( ) const

    ◆ Flag()

    int BOPDS_ShapeInfo::Flag ( ) const

    Returns the flag.

    ◆ HasBRep()

    bool BOPDS_ShapeInfo::HasBRep ( ) const

    Query Returns true if the shape has boundary representation.

    ◆ HasFlag() [1/2]

    bool BOPDS_ShapeInfo::HasFlag ( ) const

    Query Returns true if there is flag.

    ◆ HasFlag() [2/2]

    bool BOPDS_ShapeInfo::HasFlag ( int & theFlag) const

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

    ◆ HasReference()

    bool BOPDS_ShapeInfo::HasReference ( ) const

    ◆ HasSubShape()

    bool BOPDS_ShapeInfo::HasSubShape ( const int theI) const

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

    ◆ IsInterfering()

    bool BOPDS_ShapeInfo::IsInterfering ( ) const

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

    Flag

    ◆ Reference()

    int 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 int theI)

    Modifier Sets the flag.

    ◆ SetReference()

    void BOPDS_ShapeInfo::SetReference ( const int 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 NCollection_List< int > & BOPDS_ShapeInfo::SubShapes ( ) const

    Selector Returns the list of indices of sub-shapes.

    Field Documentation

    ◆ myBox

    Bnd_Box BOPDS_ShapeInfo::myBox
    protected

    ◆ myFlag

    int BOPDS_ShapeInfo::myFlag
    protected

    ◆ myReference

    int BOPDS_ShapeInfo::myReference
    protected

    ◆ myShape

    TopoDS_Shape BOPDS_ShapeInfo::myShape
    protected

    ◆ mySubShapes

    NCollection_List<int> BOPDS_ShapeInfo::mySubShapes
    protected

    ◆ myType

    TopAbs_ShapeEnum BOPDS_ShapeInfo::myType
    protected

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