Open CASCADE Technology  7.7.0
Public Types | Public Member Functions

IVtkOCC_Shape Class Reference

OCC implementation of IShape interface. More...

#include <IVtkOCC_Shape.hxx>

Inheritance diagram for IVtkOCC_Shape:
Inheritance graph
[legend]

Public Types

typedef Handle< IVtkOCC_ShapeHandle
 
- Public Types inherited from IVtk_IShape
typedef Handle< IVtk_IShapeHandle
 
- Public Types inherited from IVtk_Interface
typedef Handle< IVtk_InterfaceHandle
 
- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object. More...
 

Public Member Functions

 IVtkOCC_Shape (const TopoDS_Shape &theShape, const Handle< Prs3d_Drawer > &theDrawerLink=Handle< Prs3d_Drawer >())
 Constructor for OCC IShape implementation. More...
 
virtual ~IVtkOCC_Shape ()
 Destructor. More...
 
IVtk_IdType GetSubShapeId (const IVtk_IShape::Handle &) const
 Returns unique ID of the given sub-shape within the top-level shape. More...
 
const TopoDS_ShapeGetShape () const
 Get the wrapped original OCCT shape. More...
 
IVtk_IdType GetSubShapeId (const TopoDS_Shape &theSubShape) const
 Get local ID of a sub-shape. More...
 
IVtk_ShapeIdList GetSubIds (const IVtk_IdType) const override
 Get ids of sub-shapes composing a sub-shape with the given id. More...
 
const TopoDS_ShapeGetSubShape (const IVtk_IdType theId) const
 Get a sub-shape by its local ID. More...
 
void SetSelectableObject (const Handle< SelectMgr_SelectableObject > &theSelObj)
 Stores a handle to selectable object used by OCCT selection algorithm in a data field. This object internally caches selection data so it should be stored until the shape is no longer selectable. Note that the selectable object keeps a pointer to OccShape. More...
 
const Handle< SelectMgr_SelectableObject > & GetSelectableObject () const
 
const Handle< Prs3d_Drawer > & Attributes () const
 Return presentation attributes. More...
 
void SetAttributes (const Handle< Prs3d_Drawer > &theDrawer)
 Set presentation attributes. More...
 
- Public Member Functions inherited from IVtk_IShape
virtual ~IVtk_IShape ()
 
IVtk_IdType GetId () const
 
void SetId (const IVtk_IdType theId)
 
- Public Member Functions inherited from IVtk_Interface
virtual ~IVtk_Interface ()
 
- 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...
 

Additional Inherited Members

- 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

OCC implementation of IShape interface.

Member Typedef Documentation

◆ Handle

Constructor & Destructor Documentation

◆ IVtkOCC_Shape()

IVtkOCC_Shape::IVtkOCC_Shape ( const TopoDS_Shape theShape,
const Handle< Prs3d_Drawer > &  theDrawerLink = HandlePrs3d_Drawer >() 
)

Constructor for OCC IShape implementation.

Parameters
theShape[in] shape to display
theDrawerLink[in] default attributes to link

◆ ~IVtkOCC_Shape()

virtual IVtkOCC_Shape::~IVtkOCC_Shape ( )
virtual

Destructor.

Member Function Documentation

◆ Attributes()

const Handle< Prs3d_Drawer >& IVtkOCC_Shape::Attributes ( ) const
inline

Return presentation attributes.

◆ GetSelectableObject()

const Handle< SelectMgr_SelectableObject >& IVtkOCC_Shape::GetSelectableObject ( ) const
inline
Returns
Handle to the selectable object for this shape.

◆ GetShape()

const TopoDS_Shape& IVtkOCC_Shape::GetShape ( ) const
inline

Get the wrapped original OCCT shape.

Returns
TopoDS_Shape the wrapped original OCCT shape

◆ GetSubIds()

IVtk_ShapeIdList IVtkOCC_Shape::GetSubIds ( const  IVtk_IdType) const
overridevirtual

Get ids of sub-shapes composing a sub-shape with the given id.

Implements IVtk_IShape.

◆ GetSubShape()

const TopoDS_Shape& IVtkOCC_Shape::GetSubShape ( const IVtk_IdType  theId) const

Get a sub-shape by its local ID.

Parameters
[in]idlocal ID of a sub-shape
Returns
TopoDS_Shape& a sub-shape

◆ GetSubShapeId() [1/2]

IVtk_IdType IVtkOCC_Shape::GetSubShapeId ( const IVtk_IShape::Handle ) const

Returns unique ID of the given sub-shape within the top-level shape.

◆ GetSubShapeId() [2/2]

IVtk_IdType IVtkOCC_Shape::GetSubShapeId ( const TopoDS_Shape theSubShape) const

Get local ID of a sub-shape.

Returns unique ID of the given sub-shape within the top-level shape. Note that the sub-shape ID remains unchanged until the top-level is modified by some operation.

Parameters
[in]subShapesub-shape whose ID is returned
Returns
local ID of the sub-shape.

◆ SetAttributes()

void IVtkOCC_Shape::SetAttributes ( const Handle< Prs3d_Drawer > &  theDrawer)
inline

Set presentation attributes.

◆ SetSelectableObject()

void IVtkOCC_Shape::SetSelectableObject ( const Handle< SelectMgr_SelectableObject > &  theSelObj)
inline

Stores a handle to selectable object used by OCCT selection algorithm in a data field. This object internally caches selection data so it should be stored until the shape is no longer selectable. Note that the selectable object keeps a pointer to OccShape.

Parameters
[in]selObjHandle to the selectable object

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