Open CASCADE Technology  7.6.0
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions

IVtkTools_ShapeObject Class Reference

VTK holder class for OCC shapes to pass them through pipelines. More...

#include <IVtkTools_ShapeObject.hxx>

Inheritance diagram for IVtkTools_ShapeObject:
Inheritance graph
[legend]

Public Types

typedef vtkInformationObjectBaseKey * KeyPtr
 

Public Member Functions

 vtkTypeMacro (IVtkTools_ShapeObject, vtkDataObject) static IVtkTools_ShapeObject *New()
 
void SetShapeSource (IVtkTools_ShapeDataSource *theDataSource)
 OCC shape source setter. More...
 
IVtkTools_ShapeDataSourceGetShapeSource () const
 OCC shape source getter. More...
 

Static Public Member Functions

static vtkSmartPointer< IVtkTools_ShapeDataSourceGetShapeSource (vtkActor *theActor)
 Get OCC shape source from VTK data from actor's information object by key. More...
 
static IVtkOCC_Shape::Handle GetOccShape (vtkActor *theActor)
 Get OCC shape from VTK data from actor's information object by key. More...
 
static void SetShapeSource (IVtkTools_ShapeDataSource *theDataSource, vtkDataSet *theData)
 Static method to set OCC shape source to VTK dataset in information object with key. More...
 
static void SetShapeSource (IVtkTools_ShapeDataSource *theDataSource, vtkActor *theActor)
 Static method to set OCC shape source to VTK actor in information object with key. More...
 
static KeyPtr getKey ()
 Static method used by shape selection logic in order to establish a connection from vtkActor to OccShape instance. More...
 

Protected Member Functions

 IVtkTools_ShapeObject ()
 
virtual ~IVtkTools_ShapeObject ()
 

Detailed Description

VTK holder class for OCC shapes to pass them through pipelines.

It is descendant of vtkObject (data). Logically it is a one of milestones of VTK pipeline. It stores data of OCC shape (the OccShape instance) in vtkInformation object of vtkDataObject. Then pass it to the actors through pipelines, so selection logic can access OccShape easily given the actor instance.

Member Typedef Documentation

◆ KeyPtr

typedef vtkInformationObjectBaseKey* IVtkTools_ShapeObject::KeyPtr

Constructor & Destructor Documentation

◆ IVtkTools_ShapeObject()

IVtkTools_ShapeObject::IVtkTools_ShapeObject ( )
protected

◆ ~IVtkTools_ShapeObject()

virtual IVtkTools_ShapeObject::~IVtkTools_ShapeObject ( )
protectedvirtual

Member Function Documentation

◆ getKey()

static KeyPtr IVtkTools_ShapeObject::getKey ( )
static

Static method used by shape selection logic in order to establish a connection from vtkActor to OccShape instance.

Returns
vtkInformationKey for retrieving OccShape instance from the actor

◆ GetOccShape()

static IVtkOCC_Shape::Handle IVtkTools_ShapeObject::GetOccShape ( vtkActor *  theActor)
static

Get OCC shape from VTK data from actor's information object by key.

◆ GetShapeSource() [1/2]

IVtkTools_ShapeDataSource* IVtkTools_ShapeObject::GetShapeSource ( ) const

OCC shape source getter.

◆ GetShapeSource() [2/2]

static vtkSmartPointer<IVtkTools_ShapeDataSource> IVtkTools_ShapeObject::GetShapeSource ( vtkActor *  theActor)
static

Get OCC shape source from VTK data from actor's information object by key.

◆ SetShapeSource() [1/3]

void IVtkTools_ShapeObject::SetShapeSource ( IVtkTools_ShapeDataSource theDataSource)

OCC shape source setter.

◆ SetShapeSource() [2/3]

static void IVtkTools_ShapeObject::SetShapeSource ( IVtkTools_ShapeDataSource theDataSource,
vtkActor *  theActor 
)
static

Static method to set OCC shape source to VTK actor in information object with key.

◆ SetShapeSource() [3/3]

static void IVtkTools_ShapeObject::SetShapeSource ( IVtkTools_ShapeDataSource theDataSource,
vtkDataSet *  theData 
)
static

Static method to set OCC shape source to VTK dataset in information object with key.

◆ vtkTypeMacro()

IVtkTools_ShapeObject::vtkTypeMacro ( IVtkTools_ShapeObject  ,
vtkDataObject   
)

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