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

Rendering simple DG cells (i.e., those with a fixed reference shape). More...

#include <vtkDGRenderResponder.h>

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

Classes

struct  CacheEntry
 Entries for a cache of render-helpers. More...
 

Public Types

enum class  ScalarVisualizationOverrideType : int {
  NONE , R , S , T ,
  L2_NORM_R_S , L2_NORM_S_T , L2_NORM_T_R
}
 These properties are useful to debug/show-off/understand the parameter space and basis functions. More...
 
typedef vtkCellGridResponder< vtkCellGridRenderRequestSuperclass
 
- Public Types inherited from vtkCellGridResponder< vtkCellGridRenderRequest >
typedef vtkCellGridResponderBase Superclass
 
- Public Types inherited from vtkCellGridResponderBase
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.
 
vtkDGRenderResponderNewInstance () const
 
bool Query (vtkCellGridRenderRequest *request, vtkCellMetadata *metadata, vtkCellGridResponders *caches) override
 
void AddMod (const std::string &className)
 
void AddMods (const std::vector< std::string > &classNames)
 
void RemoveMod (const std::string &className)
 
void RemoveAllMods ()
 
void ResetModsToDefault ()
 If you removed all mods, call this to go back to default setting.
 
- Public Member Functions inherited from vtkCellGridResponder< vtkCellGridRenderRequest >
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkCellGridResponder< vtkCellGridRenderRequest > * NewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
bool EvaluateQuery (vtkCellGridQuery *query, vtkCellMetadata *cellType, vtkCellGridResponders *caches) override
 Respond to the query for cells of cellType, possibly using caches.
 
virtual bool Query (vtkCellGridRenderRequest *query, vtkCellMetadata *cellType, vtkCellGridResponders *caches)=0
 
- Public Member Functions inherited from vtkCellGridResponderBase
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkCellGridResponderBaseNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
virtual bool EvaluateQuery (vtkCellGridQuery *query, vtkCellMetadata *cellType, vtkCellGridResponders *caches)=0
 Respond to the query for cells of cellType, possibly using caches.
 
- 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 vtkDGRenderResponderNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkDGRenderResponderSafeDownCast (vtkObjectBase *o)
 
static void SetScalarVisualizationOverrideType (ScalarVisualizationOverrideType type)
 
static void SetVisualizeTessellation (bool value)
 
- Static Public Member Functions inherited from vtkCellGridResponder< vtkCellGridRenderRequest >
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkCellGridResponder< vtkCellGridRenderRequest > * SafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkCellGridResponderBase
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkCellGridResponderBaseSafeDownCast (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
 
 vtkDGRenderResponder ()
 
 ~vtkDGRenderResponder () override=default
 
bool DrawCells (vtkCellGridRenderRequest *request, vtkCellMetadata *metadata)
 
bool ReleaseResources (vtkCellGridRenderRequest *request, vtkCellMetadata *metadata)
 
bool DrawShapes (vtkCellGridRenderRequest *request, vtkDGCell *metadata, const vtkDGCell::Source &cellSource, int cellTypeIdx, std::size_t specIdx)
 
- Protected Member Functions inherited from vtkCellGridResponder< vtkCellGridRenderRequest >
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkCellGridResponder ()=default
 
 ~vtkCellGridResponder () override=default
 
- Protected Member Functions inherited from vtkCellGridResponderBase
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkCellGridResponderBase ()=default
 
 ~vtkCellGridResponderBase () 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 &)
 

Static Protected Member Functions

static vtkDrawTexturedElements::ElementShape PrimitiveFromShape (vtkDGCell::Shape shape)
 
static vtkDrawTexturedElements::PatchShape PatchPrimitiveFromShape (vtkDGCell::Shape shape)
 
- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 

Protected Attributes

std::set< CacheEntryHelpers
 
std::vector< std::string > ModNames
 
std::set< std::string > ModNamesUnique
 
- 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
 

Static Protected Attributes

static std::vector< std::string > DefaultModNames
 
static ScalarVisualizationOverrideType ScalarVisualizationOverride
 Default is None.
 
static bool VisualizeTessellation
 These properties are useful to debug/show-off/understand dynamic distance-based tessellation.
 

Detailed Description

Rendering simple DG cells (i.e., those with a fixed reference shape).

This currently handles hexahedra, tetrahedra, quadrilaterals, and triangles.

Tests:
vtkDGRenderResponder (Tests)

Definition at line 35 of file vtkDGRenderResponder.h.

Member Typedef Documentation

◆ Superclass

Definition at line 40 of file vtkDGRenderResponder.h.

Member Enumeration Documentation

◆ ScalarVisualizationOverrideType

These properties are useful to debug/show-off/understand the parameter space and basis functions.

The cell faces are shaded by colors that map to either of these quantities. All function values are normalized to [0, 1] before being mapped through the scalar's color map.

Enumerator
NONE 
L2_NORM_R_S 
L2_NORM_S_T 
L2_NORM_T_R 

Definition at line 57 of file vtkDGRenderResponder.h.

Constructor & Destructor Documentation

◆ vtkDGRenderResponder()

vtkDGRenderResponder::vtkDGRenderResponder ( )
protected

◆ ~vtkDGRenderResponder()

vtkDGRenderResponder::~vtkDGRenderResponder ( )
overrideprotecteddefault

Member Function Documentation

◆ New()

static vtkDGRenderResponder * vtkDGRenderResponder::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkDGRenderResponder::IsA ( const char *  type)
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 vtkCellGridResponder< vtkCellGridRenderRequest >.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkDGRenderResponder::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkDGRenderResponder * vtkDGRenderResponder::NewInstance ( ) const

◆ Query()

bool vtkDGRenderResponder::Query ( vtkCellGridRenderRequest request,
vtkCellMetadata metadata,
vtkCellGridResponders caches 
)
overridevirtual

◆ AddMod()

void vtkDGRenderResponder::AddMod ( const std::string &  className)

◆ AddMods()

void vtkDGRenderResponder::AddMods ( const std::vector< std::string > &  classNames)

◆ RemoveMod()

void vtkDGRenderResponder::RemoveMod ( const std::string &  className)

◆ RemoveAllMods()

void vtkDGRenderResponder::RemoveAllMods ( )

◆ ResetModsToDefault()

void vtkDGRenderResponder::ResetModsToDefault ( )

If you removed all mods, call this to go back to default setting.

◆ SetScalarVisualizationOverrideType()

static void vtkDGRenderResponder::SetScalarVisualizationOverrideType ( ScalarVisualizationOverrideType  type)
inlinestatic

Definition at line 68 of file vtkDGRenderResponder.h.

◆ SetVisualizeTessellation()

static void vtkDGRenderResponder::SetVisualizeTessellation ( bool  value)
inlinestatic

Definition at line 73 of file vtkDGRenderResponder.h.

◆ DrawCells()

bool vtkDGRenderResponder::DrawCells ( vtkCellGridRenderRequest request,
vtkCellMetadata metadata 
)
protected

◆ ReleaseResources()

bool vtkDGRenderResponder::ReleaseResources ( vtkCellGridRenderRequest request,
vtkCellMetadata metadata 
)
protected

◆ DrawShapes()

bool vtkDGRenderResponder::DrawShapes ( vtkCellGridRenderRequest request,
vtkDGCell metadata,
const vtkDGCell::Source cellSource,
int  cellTypeIdx,
std::size_t  specIdx 
)
protected

◆ PrimitiveFromShape()

static vtkDrawTexturedElements::ElementShape vtkDGRenderResponder::PrimitiveFromShape ( vtkDGCell::Shape  shape)
staticprotected

◆ PatchPrimitiveFromShape()

static vtkDrawTexturedElements::PatchShape vtkDGRenderResponder::PatchPrimitiveFromShape ( vtkDGCell::Shape  shape)
staticprotected

Member Data Documentation

◆ Helpers

std::set<CacheEntry> vtkDGRenderResponder::Helpers
protected

Definition at line 152 of file vtkDGRenderResponder.h.

◆ ModNames

std::vector<std::string> vtkDGRenderResponder::ModNames
protected

Definition at line 156 of file vtkDGRenderResponder.h.

◆ ModNamesUnique

std::set<std::string> vtkDGRenderResponder::ModNamesUnique
protected

Definition at line 157 of file vtkDGRenderResponder.h.

◆ DefaultModNames

std::vector<std::string> vtkDGRenderResponder::DefaultModNames
staticprotected

Definition at line 158 of file vtkDGRenderResponder.h.

◆ ScalarVisualizationOverride

ScalarVisualizationOverrideType vtkDGRenderResponder::ScalarVisualizationOverride
staticprotected

Default is None.

When this value is not None, that quantity is visualized instead of the currently set color array.

Definition at line 162 of file vtkDGRenderResponder.h.

◆ VisualizeTessellation

bool vtkDGRenderResponder::VisualizeTessellation
staticprotected

These properties are useful to debug/show-off/understand dynamic distance-based tessellation.

Definition at line 165 of file vtkDGRenderResponder.h.


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