vtkWebGPUCellToPrimitiveConverter Class Reference

Converts VTK cell connectivity arrays into webgpu primitives using compute shaders. More...

#include <vtkWebGPUCellToPrimitiveConverter.h>

Inheritance diagram for vtkWebGPUCellToPrimitiveConverter:

Collaboration diagram for vtkWebGPUCellToPrimitiveConverter:

Public Types
enum	TopologySourceType : int {   TOPOLOGY_SOURCE_VERTS = 0 , TOPOLOGY_SOURCE_LINES , TOPOLOGY_SOURCE_LINE_POINTS , TOPOLOGY_SOURCE_POLYGONS ,   TOPOLOGY_SOURCE_POLYGON_POINTS , TOPOLOGY_SOURCE_POLYGON_EDGES , NUM_TOPOLOGY_SOURCE_TYPES }
	All supported types of topology. More...
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.
vtkWebGPUCellToPrimitiveConverter *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
void	ReleaseGraphicsResources (vtkWindow *)
	Release any graphics resources that are being consumed by this mapper.
bool	DispatchMeshToPrimitiveComputePipeline (vtkWebGPUConfiguration *wgpuConfiguration, vtkPolyData *mesh, int representation, vtkTypeUInt32 *vertexCounts[NUM_TOPOLOGY_SOURCE_TYPES], wgpu::Buffer *topologyBuffers[NUM_TOPOLOGY_SOURCE_TYPES], wgpu::Buffer *edgeArrayBuffers[NUM_TOPOLOGY_SOURCE_TYPES])
	Tessellates the cells in a mesh into graphics primitives.
bool	DispatchCellToPrimitiveComputePipeline (vtkWebGPUConfiguration *wgpuConfiguration, vtkCellArray *cells, int representation, int cellType, vtkIdType cellIdOffset, vtkTypeUInt32 *vertexCounts[NUM_TOPOLOGY_SOURCE_TYPES], wgpu::Buffer *topologyBuffers[NUM_TOPOLOGY_SOURCE_TYPES], wgpu::Buffer *edgeArrayBuffers[NUM_TOPOLOGY_SOURCE_TYPES])
	Tessellates each cell into primitives.
bool	GetNeedToRebuildCellToPrimitiveComputePipeline (vtkCellArray *cells, vtkWebGPUCellToPrimitiveConverter::TopologySourceType topologySourceType)
	Get whether the Cell-to-Primitive compute pipeline needs rebuilt.
void	UpdateCellToPrimitiveComputePipelineTimestamp (vtkWebGPUCellToPrimitiveConverter::TopologySourceType topologySourceType)
	Brings the build timestamp of the compute pipeline associated with cellType up to date.
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.
vtkCommand *	GetCommand (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 vtkWebGPUCellToPrimitiveConverter *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
static vtkWebGPUCellToPrimitiveConverter *	SafeDownCast (vtkObjectBase *o)
static vtkIdType	GetTessellatedPrimitiveSizeOffsetForCellType (int cellType)
	Query the integer that, when subtracted from the no.
static const char *	GetTopologySourceTypeAsString (TopologySourceType topologySourceType)
	Get the name of the topology source type as a string.
static const char *	GetCellTypeAsString (int cellType)
	Get the name of the VTK cell type as a string.
static const char *	GetTessellatedPrimitiveTypeAsString (TopologySourceType topologySourceType)
	Get the name of the sub primitive of a VTK cell type as a string.
static std::size_t	GetTessellatedPrimitiveSize (TopologySourceType topologySourceType)
	Get the number of points in the sub primitive of a VTK cell type.
static TopologySourceType	GetTopologySourceTypeForCellType (int cellType, int representation=VTK_SURFACE)
	A convenient method to get the relevant TopologyRenderInfo instance for a cellType.
Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	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 vtkObjectBase *	New ()
	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 vtkObjectBase *	NewInstanceInternal () const
	vtkWebGPUCellToPrimitiveConverter ()
	~vtkWebGPUCellToPrimitiveConverter () override
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
vtkTimeStamp	TopologyBuildTimestamp [vtkWebGPUCellToPrimitiveConverter::NUM_TOPOLOGY_SOURCE_TYPES]
vtkSmartPointer< vtkWebGPUComputePass >	ComputePasses [vtkWebGPUCellToPrimitiveConverter::NUM_TOPOLOGY_SOURCE_TYPES]
vtkSmartPointer< vtkWebGPUComputePipeline >	ComputePipelines [vtkWebGPUCellToPrimitiveConverter::NUM_TOPOLOGY_SOURCE_TYPES]
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

Converts VTK cell connectivity arrays into webgpu primitives using compute shaders.

When given only vertices, lines and triangles and using 32-bit integer IDs, this class opts into low memory code paths, i.e, does not copy indices into new arrays.

When input has poly-vertices, poly-lines and polygons or triangle strips or uses 64-bit integer IDs, this class converts the underlying cell array storage to 32-bit. Itmakes an additional copy of the indices.

This class can process millions of polygons, lines, vertices very quickly in parallel.

See also

vtkPolyDataMapper2D

Definition at line 40 of file vtkWebGPUCellToPrimitiveConverter.h.

Member Typedef Documentation

Superclass

typedef vtkObject vtkWebGPUCellToPrimitiveConverter::Superclass

Definition at line 44 of file vtkWebGPUCellToPrimitiveConverter.h.

Member Enumeration Documentation

TopologySourceType

enum vtkWebGPUCellToPrimitiveConverter::TopologySourceType : int

All supported types of topology.

These describe the kinds of cells found in a vtkPolyData.

Enumerator
TOPOLOGY_SOURCE_VERTS
TOPOLOGY_SOURCE_LINES
TOPOLOGY_SOURCE_LINE_POINTS
TOPOLOGY_SOURCE_POLYGONS
TOPOLOGY_SOURCE_POLYGON_POINTS
TOPOLOGY_SOURCE_POLYGON_EDGES
NUM_TOPOLOGY_SOURCE_TYPES

Definition at line 58 of file vtkWebGPUCellToPrimitiveConverter.h.

Constructor & Destructor Documentation

vtkWebGPUCellToPrimitiveConverter()

vtkWebGPUCellToPrimitiveConverter::vtkWebGPUCellToPrimitiveConverter ( )

protected

~vtkWebGPUCellToPrimitiveConverter()

vtkWebGPUCellToPrimitiveConverter::~vtkWebGPUCellToPrimitiveConverter ( )

overrideprotected

Member Function Documentation

New()

static vtkWebGPUCellToPrimitiveConverter * vtkWebGPUCellToPrimitiveConverter::New ( )

static

IsTypeOf()

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

static

IsA()

virtual vtkTypeBool vtkWebGPUCellToPrimitiveConverter::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 vtkObjectBase.

SafeDownCast()

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

static

NewInstanceInternal()

virtual vtkObjectBase * vtkWebGPUCellToPrimitiveConverter::NewInstanceInternal ( ) const

protectedvirtual

NewInstance()

vtkWebGPUCellToPrimitiveConverter * vtkWebGPUCellToPrimitiveConverter::NewInstance

(

)

const

PrintSelf()

void vtkWebGPUCellToPrimitiveConverter::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 vtkObject.

ReleaseGraphicsResources()

void vtkWebGPUCellToPrimitiveConverter::ReleaseGraphicsResources

(

vtkWindow *

)

Release any graphics resources that are being consumed by this mapper.

The parameter window could be used to determine which graphic resources to release.

DispatchMeshToPrimitiveComputePipeline()

bool vtkWebGPUCellToPrimitiveConverter::DispatchMeshToPrimitiveComputePipeline	(	vtkWebGPUConfiguration *	wgpuConfiguration,
		vtkPolyData *	mesh,
		int	representation,
		vtkTypeUInt32 *	vertexCounts[NUM_TOPOLOGY_SOURCE_TYPES],
		wgpu::Buffer *	topologyBuffers[NUM_TOPOLOGY_SOURCE_TYPES],
		wgpu::Buffer *	edgeArrayBuffers[NUM_TOPOLOGY_SOURCE_TYPES]
	)

Tessellates the cells in a mesh into graphics primitives.

This function calls DispatchCellToPrimitiveComputePipeline() for

• vtkPolyData::GetVerts()
• vtkPolyData::GetLines()
• vtkPolyData::GetPolys() This method will initialize the vertexCounts, topologyBuffers and edgeArrayBuffers after dispatching the compute pipelines. Returns false if no buffers have changed, else returns true.

DispatchCellToPrimitiveComputePipeline()

bool vtkWebGPUCellToPrimitiveConverter::DispatchCellToPrimitiveComputePipeline	(	vtkWebGPUConfiguration *	wgpuConfiguration,
		vtkCellArray *	cells,
		int	representation,
		int	cellType,
		vtkIdType	cellIdOffset,
		vtkTypeUInt32 *	vertexCounts[NUM_TOPOLOGY_SOURCE_TYPES],
		wgpu::Buffer *	topologyBuffers[NUM_TOPOLOGY_SOURCE_TYPES],
		wgpu::Buffer *	edgeArrayBuffers[NUM_TOPOLOGY_SOURCE_TYPES]
	)

Tessellates each cell into primitives.

This function splits polygons, quads and triangle-strips into separate triangles. It splits polylines into line segments and polyvertices into individual vertices. This method will initialize the vertexCounts, topologyBuffers and edgeArrayBuffers after dispatching the compute pipelines. Returns false if no buffers have changed, else returns true.

GetNeedToRebuildCellToPrimitiveComputePipeline()

bool vtkWebGPUCellToPrimitiveConverter::GetNeedToRebuildCellToPrimitiveComputePipeline	(	vtkCellArray *	cells,
		vtkWebGPUCellToPrimitiveConverter::TopologySourceType	topologySourceType
	)

Get whether the Cell-to-Primitive compute pipeline needs rebuilt.

This method checks MTime of the vtkCellArray against the build timestamp of the relevant compute pipeline.

UpdateCellToPrimitiveComputePipelineTimestamp()

void vtkWebGPUCellToPrimitiveConverter::UpdateCellToPrimitiveComputePipelineTimestamp

(

vtkWebGPUCellToPrimitiveConverter::TopologySourceType

topologySourceType

)

Brings the build timestamp of the compute pipeline associated with cellType up to date.

GetTessellatedPrimitiveSizeOffsetForCellType()

static vtkIdType vtkWebGPUCellToPrimitiveConverter::GetTessellatedPrimitiveSizeOffsetForCellType ( int  cellType )

static

Query the integer that, when subtracted from the no.

of vertices of a polygon gives the number of sub primitives.

Example: there are n - 2 triangles in a n-sided polygon, so this function returns '2' for VTK_POLYGON

GetTopologySourceTypeAsString()

static const char * vtkWebGPUCellToPrimitiveConverter::GetTopologySourceTypeAsString ( TopologySourceType  topologySourceType )

static

Get the name of the topology source type as a string.

GetCellTypeAsString()

static const char * vtkWebGPUCellToPrimitiveConverter::GetCellTypeAsString ( int  cellType )

static

Get the name of the VTK cell type as a string.

GetTessellatedPrimitiveTypeAsString()

static const char * vtkWebGPUCellToPrimitiveConverter::GetTessellatedPrimitiveTypeAsString ( TopologySourceType  topologySourceType )

static

Get the name of the sub primitive of a VTK cell type as a string.

Ex: "vertex", "line", "triangle"

GetTessellatedPrimitiveSize()

static std::size_t vtkWebGPUCellToPrimitiveConverter::GetTessellatedPrimitiveSize ( TopologySourceType  topologySourceType )

static

Get the number of points in the sub primitive of a VTK cell type.

GetTopologySourceTypeForCellType()

static TopologySourceType vtkWebGPUCellToPrimitiveConverter::GetTopologySourceTypeForCellType ( int  cellType, int  representation = VTK_SURFACE  )

static

A convenient method to get the relevant TopologyRenderInfo instance for a cellType.

Member Data Documentation

TopologyBuildTimestamp

vtkTimeStamp vtkWebGPUCellToPrimitiveConverter::TopologyBuildTimestamp[vtkWebGPUCellToPrimitiveConverter::NUM_TOPOLOGY_SOURCE_TYPES]

protected

Definition at line 162 of file vtkWebGPUCellToPrimitiveConverter.h.

ComputePasses

vtkSmartPointer<vtkWebGPUComputePass> vtkWebGPUCellToPrimitiveConverter::ComputePasses[vtkWebGPUCellToPrimitiveConverter::NUM_TOPOLOGY_SOURCE_TYPES]

protected

Definition at line 165 of file vtkWebGPUCellToPrimitiveConverter.h.

ComputePipelines

vtkSmartPointer<vtkWebGPUComputePipeline> vtkWebGPUCellToPrimitiveConverter::ComputePipelines[vtkWebGPUCellToPrimitiveConverter::NUM_TOPOLOGY_SOURCE_TYPES]

protected

Definition at line 168 of file vtkWebGPUCellToPrimitiveConverter.h.

---

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

• Rendering/WebGPU/vtkWebGPUCellToPrimitiveConverter.h