VTK  9.4.20241121
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkCellGridRenderRequest Class Reference

State used by vtkCellGridMapper during rendering. More...

#include <vtkCellGridRenderRequest.h>

Inheritance diagram for vtkCellGridRenderRequest:
[legend]
Collaboration diagram for vtkCellGridRenderRequest:
[legend]

Classes

class  BaseState
 

Public Types

enum  RenderableGeometry : unsigned char {
  VERTICES = 1 , EDGES = 2 , FACES = 4 , VOLUMES = 8 ,
  SURFACE_WITH_EDGES = EDGES | FACES , ALL = VERTICES | EDGES | FACES | VOLUMES
}
 An enumeration of which shapes to render. More...
 
typedef vtkCellGridQuery Superclass
 
- Public Types inherited from vtkCellGridQuery
typedef vtkObject Superclass
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkCellGridRenderRequestNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
virtual void SetMapper (vtkCellGridMapper *mapper)
 Set/get the mapper which owns this request (so responders can inspect its configuration).
 
virtual vtkCellGridMapperGetMapper ()
 
virtual void SetActor (vtkActor *actor)
 Set/get the actor which responders should use to draw cells.
 
virtual vtkActorGetActor ()
 
virtual void SetRenderer (vtkRenderer *renderer)
 Set/get the renderer responders should use to draw cells.
 
virtual vtkRendererGetRenderer ()
 
virtual void SetWindow (vtkWindow *window)
 Set/get a window (used when IsReleasingResources is true).
 
virtual vtkWindowGetWindow ()
 
virtual char GetShapesToDraw ()
 Set/get what geometric data to draw for each cell.
 
virtual void SetShapesToDraw (char)
 
bool Initialize () override
 This is invoked before processing any cell types during a render.
 
bool Finalize () override
 This is invoked after processing all cell types during a render.
 
virtual bool GetIsReleasingResources ()
 Set/get whether the request should render (false) or release resources (true).
 
virtual void SetIsReleasingResources (bool)
 
template<typename StateType >
StateType * GetState (vtkStringToken cellType, bool create=true)
 Return a state object of the given type.
 
- Public Member Functions inherited from vtkCellGridQuery
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkCellGridQueryNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
virtual bool Initialize ()
 Override this if your query-result state requires initialization.
 
virtual void StartPass ()
 Mark the start of a pass through each cell type.
 
virtual int GetPass ()
 Return the current pass (the number of times each responder has been evaluated so far).
 
virtual bool IsAnotherPassRequired ()
 Override this if your query allows responders to execute in multiple phases.
 
virtual bool Finalize ()
 Override this if your query-result state requires finalization.
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on.
 
virtual void DebugOff ()
 Turn debugging output off.
 
bool GetDebug ()
 Get the value of the debug flag.
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag.
 
virtual void Modified ()
 Update the modification time for this object.
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time.
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
vtkTypeBool InvokeEvent (unsigned long event)
 
vtkTypeBool InvokeEvent (const char *event)
 
std::string GetObjectDescription () const override
 The object description printed in messages and PrintSelf output.
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method.
 
vtkTypeBool InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
vtkTypeBool InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
virtual void SetObjectName (const std::string &objectName)
 Set/get the name of this object for reporting purposes.
 
virtual std::string GetObjectName () const
 Set/get the name of this object for reporting purposes.
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string.
 
virtual std::string GetObjectDescription () const
 The object description printed in messages and PrintSelf output.
 
virtual vtkTypeBool IsA (const char *name)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
virtual vtkIdType GetNumberOfGenerationsFromBase (const char *name)
 Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
 
virtual void Delete ()
 Delete a VTK object.
 
virtual void FastDelete ()
 Delete a reference to this object.
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream.
 
void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object).
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object).
 
int GetReferenceCount ()
 Return the current reference count of this object.
 
void SetReferenceCount (int)
 Sets the reference count.
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space.
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.
 
virtual bool UsesGarbageCollector () const
 Indicate whether the class uses vtkGarbageCollector or not.
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkCellGridRenderRequestSafeDownCast (vtkObjectBase *o)
 
static vtkCellGridRenderRequestNew ()
 
- Static Public Member Functions inherited from vtkCellGridQuery
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkCellGridQuerySafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes.
 
static void SetGlobalWarningDisplay (vtkTypeBool val)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static vtkTypeBool GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class.
 
static vtkIdType GetNumberOfGenerationsFromBaseType (const char *name)
 Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
 
static bool GetUsingMemkind ()
 A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkCellGridRenderRequest ()=default
 
 ~vtkCellGridRenderRequest () override
 
- Protected Member Functions inherited from vtkCellGridQuery
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkCellGridQuery ()=default
 
 ~vtkCellGridQuery () override=default
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events.
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events.
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void RegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
virtual void ObjectFinalize ()
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkCellGridMapperMapper { nullptr }
 
vtkActorActor { nullptr }
 
vtkRendererRenderer { nullptr }
 
vtkWindowWindow { nullptr }
 
bool IsReleasingResources { false }
 
char ShapesToDraw { RenderableGeometry::ALL }
 
std::unordered_map< vtkStringToken, std::unique_ptr< BaseState > > State
 
- Protected Attributes inherited from vtkCellGridQuery
int Pass { -1 }
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
std::string ObjectName
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 

Detailed Description

State used by vtkCellGridMapper during rendering.

This is a vtkCellGridQuery subclass that mappers can use to draw cells into a renderer using an actor and, subsequently, to release resources.

Note that this request has two modes: it will either instruct responders to draw cells (IsReleasingResources == false) or instruct responders to release OpenGL objects for a particular window (when IsReleasingResources == true). Responders must call GetIsReleasingResources() and only perform one task or the other, depending on the returned value.

Definition at line 33 of file vtkCellGridRenderRequest.h.

Member Typedef Documentation

◆ Superclass

Definition at line 65 of file vtkCellGridRenderRequest.h.

Member Enumeration Documentation

◆ RenderableGeometry

An enumeration of which shapes to render.

A cell may be represented by its interior and/or its boundaries of any dimension. These enumerants indicate the dimension of shape to render as a representation of the cell.

The default is to render the cell's shape itself (if possible) and any sides for which arrays exist. Note that the cell-grid mapper does not currently support volume rendering, so VOLUME is ignored; if you wish to render volumetric cells, you must run the vtkCellGridExtractSurface filter to generate side-set arrays for boundaries of interest.

Enumerator
VERTICES 
EDGES 
FACES 
VOLUMES 
SURFACE_WITH_EDGES 
ALL 

Definition at line 55 of file vtkCellGridRenderRequest.h.

Constructor & Destructor Documentation

◆ vtkCellGridRenderRequest()

vtkCellGridRenderRequest::vtkCellGridRenderRequest ( )
protecteddefault

◆ ~vtkCellGridRenderRequest()

vtkCellGridRenderRequest::~vtkCellGridRenderRequest ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

static vtkTypeBool vtkCellGridRenderRequest::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual vtkTypeBool vtkCellGridRenderRequest::IsA ( const char *  name)
virtual

Return 1 if this class is the same type of (or a subclass of) the named class.

Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkCellGridQuery.

◆ SafeDownCast()

static vtkCellGridRenderRequest * vtkCellGridRenderRequest::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkCellGridRenderRequest::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkCellGridQuery.

◆ NewInstance()

vtkCellGridRenderRequest * vtkCellGridRenderRequest::NewInstance ( ) const

◆ New()

static vtkCellGridRenderRequest * vtkCellGridRenderRequest::New ( )
static

◆ PrintSelf()

void vtkCellGridRenderRequest::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkCellGridQuery.

◆ SetMapper()

virtual void vtkCellGridRenderRequest::SetMapper ( vtkCellGridMapper mapper)
virtual

Set/get the mapper which owns this request (so responders can inspect its configuration).

Note that the render request does NOT increase the reference count of the mapper (thus it does not take ownership). This is because the request is owned by the mapper and we do not want to create a reference loop.

◆ GetMapper()

virtual vtkCellGridMapper * vtkCellGridRenderRequest::GetMapper ( )
virtual

◆ SetActor()

virtual void vtkCellGridRenderRequest::SetActor ( vtkActor actor)
virtual

Set/get the actor which responders should use to draw cells.

Note that the render request does NOT increase the reference count of the actor (thus it does not take ownership). This is to avoid creating a reference loop.

◆ GetActor()

virtual vtkActor * vtkCellGridRenderRequest::GetActor ( )
virtual

◆ SetRenderer()

virtual void vtkCellGridRenderRequest::SetRenderer ( vtkRenderer renderer)
virtual

Set/get the renderer responders should use to draw cells.

Note that the render request does NOT increase the reference count of the renderer (thus it does not take ownership). This is to avoid creating a reference loop.

◆ GetRenderer()

virtual vtkRenderer * vtkCellGridRenderRequest::GetRenderer ( )
virtual

◆ SetWindow()

virtual void vtkCellGridRenderRequest::SetWindow ( vtkWindow window)
virtual

Set/get a window (used when IsReleasingResources is true).

Note that the render request does NOT increase the reference count of the window (thus it does not take ownership). This is to avoid creating a reference loop.

◆ GetWindow()

virtual vtkWindow * vtkCellGridRenderRequest::GetWindow ( )
virtual

◆ GetShapesToDraw()

virtual char vtkCellGridRenderRequest::GetShapesToDraw ( )
virtual

Set/get what geometric data to draw for each cell.

The DEFAULT is currently equivalent to ALL. Note that any combination of RenderableGeometry enumerants is accepted.

See also
RenderableGeometry

◆ SetShapesToDraw()

virtual void vtkCellGridRenderRequest::SetShapesToDraw ( char  )
virtual

◆ Initialize()

bool vtkCellGridRenderRequest::Initialize ( )
overridevirtual

This is invoked before processing any cell types during a render.

Reimplemented from vtkCellGridQuery.

◆ Finalize()

bool vtkCellGridRenderRequest::Finalize ( )
overridevirtual

This is invoked after processing all cell types during a render.

Reimplemented from vtkCellGridQuery.

◆ GetIsReleasingResources()

virtual bool vtkCellGridRenderRequest::GetIsReleasingResources ( )
virtual

Set/get whether the request should render (false) or release resources (true).

The latter should be performed as a separate query after rendering.

Note that after a successful call to Query with IsReleasingResources set to true, the Finalize() method will reset IsReleasingResources to false, which results in the request being marked modified.

◆ SetIsReleasingResources()

virtual void vtkCellGridRenderRequest::SetIsReleasingResources ( bool  )
virtual

◆ GetState()

template<typename StateType >
StateType * vtkCellGridRenderRequest::GetState ( vtkStringToken  cellType,
bool  create = true 
)
inline

Return a state object of the given type.

This method is intended for responders to store data with the request.

Definition at line 132 of file vtkCellGridRenderRequest.h.

Member Data Documentation

◆ Mapper

vtkCellGridMapper* vtkCellGridRenderRequest::Mapper { nullptr }
protected

Definition at line 154 of file vtkCellGridRenderRequest.h.

◆ Actor

vtkActor* vtkCellGridRenderRequest::Actor { nullptr }
protected

Definition at line 155 of file vtkCellGridRenderRequest.h.

◆ Renderer

vtkRenderer* vtkCellGridRenderRequest::Renderer { nullptr }
protected

Definition at line 156 of file vtkCellGridRenderRequest.h.

◆ Window

vtkWindow* vtkCellGridRenderRequest::Window { nullptr }
protected

Definition at line 157 of file vtkCellGridRenderRequest.h.

◆ IsReleasingResources

bool vtkCellGridRenderRequest::IsReleasingResources { false }
protected

Definition at line 158 of file vtkCellGridRenderRequest.h.

◆ ShapesToDraw

char vtkCellGridRenderRequest::ShapesToDraw { RenderableGeometry::ALL }
protected

Definition at line 159 of file vtkCellGridRenderRequest.h.

◆ State

std::unordered_map<vtkStringToken, std::unique_ptr<BaseState> > vtkCellGridRenderRequest::State
protected

Definition at line 160 of file vtkCellGridRenderRequest.h.


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