vtkCompositeDataDisplayAttributes Class Reference

Rendering attributes for a multi-block dataset. More...

#include <vtkCompositeDataDisplayAttributes.h>

Inheritance diagram for vtkCompositeDataDisplayAttributes:

Collaboration diagram for vtkCompositeDataDisplayAttributes:

Public Types
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.
vtkCompositeDataDisplayAttributes *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
bool	HasBlockVisibilities () const
	Returns true if any block has any block visibility is set.
bool	HasBlockVisibility (vtkDataObject *data_object) const
	Returns true if the block with the given data_object has a visibility set.
void	RemoveBlockVisibility (vtkDataObject *data_object)
	Removes the block visibility flag for the block with data_object.
void	RemoveBlockVisibilities ()
	Removes all block visibility flags.
bool	HasBlockPickabilities () const
	Returns true if any block has any block pickability is set.
bool	HasBlockPickability (vtkDataObject *data_object) const
	Returns true if the block with the given data_object has a pickability set.
void	RemoveBlockPickability (vtkDataObject *data_object)
	Removes the block pickability flag for the block with data_object.
void	RemoveBlockPickabilities ()
	Removes all block pickability flags.
bool	HasBlockColors () const
	Returns true if any block has any block color is set.
bool	HasBlockColor (vtkDataObject *data_object) const
	Returns true if the block with the given data_object has a color.
void	RemoveBlockColor (vtkDataObject *data_object)
	Removes the block color for the block with data_object.
void	RemoveBlockColors ()
	Removes all block colors.
bool	HasBlockOpacities () const
	Returns true if any block has an opacity set.
bool	HasBlockOpacity (vtkDataObject *data_object) const
	Returns true if the block with data_object has an opacity set.
void	RemoveBlockOpacity (vtkDataObject *data_object)
	Removes the set opacity for the block with data_object.
void	RemoveBlockOpacities ()
	Removes all block opacities.
bool	HasBlockMaterials () const
	Returns true if any block has an material set.
bool	HasBlockMaterial (vtkDataObject *data_object) const
	Returns true if the block with data_object has an material set.
void	RemoveBlockMaterial (vtkDataObject *data_object)
	Removes the set material for the block with data_object.
void	RemoveBlockMaterials ()
	Removes all block materialss.
void	VisitVisibilities (std::function< bool(vtkDataObject *, bool)> visitor)
void	SetBlockVisibility (vtkDataObject *data_object, bool visible)
	Set/get the visibility for the block with data_object.
bool	GetBlockVisibility (vtkDataObject *data_object) const
	Set/get the visibility for the block with data_object.
void	SetBlockPickability (vtkDataObject *data_object, bool visible)
	Set/get the pickability for the block with data_object.
bool	GetBlockPickability (vtkDataObject *data_object) const
	Set/get the pickability for the block with data_object.
void	SetBlockColor (vtkDataObject *data_object, const double color[3])
	Set/get the color for the block with data_object.
void	GetBlockColor (vtkDataObject *data_object, double color[3]) const
	Set/get the color for the block with data_object.
vtkColor3d	GetBlockColor (vtkDataObject *data_object) const
	Set/get the color for the block with data_object.
void	SetBlockOpacity (vtkDataObject *data_object, double opacity)
	Set/get the opacity for the block with data_object.
double	GetBlockOpacity (vtkDataObject *data_object) const
	Set/get the opacity for the block with data_object.
void	SetBlockMaterial (vtkDataObject *data_object, const std::string &material)
	Set/get the material for the block with data_object.
const std::string &	GetBlockMaterial (vtkDataObject *data_object) const
	Set/get the material for the block with data_object.
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)
int	InvokeEvent (unsigned long event)
int	InvokeEvent (const char *event)
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.
int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
int	InvokeEvent (const char *event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.
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.
virtual 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.

Static Public Member Functions
static vtkCompositeDataDisplayAttributes *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
static vtkCompositeDataDisplayAttributes *	SafeDownCast (vtkObjectBase *o)
static void	ComputeVisibleBounds (vtkCompositeDataDisplayAttributes *cda, vtkDataObject *dobj, double bounds[6])
	If the input dobj is a vtkCompositeDataSet, we will loop over the hierarchy recursively starting from initial index 0 and use only visible blocks, which is specified in the vtkCompositeDataDisplayAttributes cda, to compute the bounds.
static vtkDataObject *	DataObjectFromIndex (const unsigned int flat_index, vtkDataObject *parent_obj, unsigned int current_flat_index=0)
	Get the DataObject corresponding to the node with index flat_index under parent_obj.
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 (int 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 int	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
	vtkCompositeDataDisplayAttributes ()
	~vtkCompositeDataDisplayAttributes () 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 *)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()
static vtkReallocingFunction	GetCurrentReallocFunction ()
static vtkFreeingFunction	GetCurrentFreeFunction ()
static vtkFreeingFunction	GetAlternateFreeFunction ()
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Detailed Description

Rendering attributes for a multi-block dataset.

The vtkCompositeDataDisplayAttributes class stores display attributes for individual blocks in a multi-block dataset. It uses the actual data block's pointer as a key (vtkDataObject*).

Warning

It is considered unsafe to dereference key pointers at any time, they should only serve as keys to access the internal map.

Online Examples:

CompositePolyDataMapper

Definition at line 58 of file vtkCompositeDataDisplayAttributes.h.

Member Typedef Documentation

Superclass

typedef vtkObject vtkCompositeDataDisplayAttributes::Superclass

Definition at line 62 of file vtkCompositeDataDisplayAttributes.h.

Constructor & Destructor Documentation

vtkCompositeDataDisplayAttributes()

vtkCompositeDataDisplayAttributes::vtkCompositeDataDisplayAttributes ( )

protected

~vtkCompositeDataDisplayAttributes()

vtkCompositeDataDisplayAttributes::~vtkCompositeDataDisplayAttributes ( )

overrideprotected

Member Function Documentation

New()

static vtkCompositeDataDisplayAttributes * vtkCompositeDataDisplayAttributes::New ( )

static

IsTypeOf()

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

static

IsA()

virtual vtkTypeBool vtkCompositeDataDisplayAttributes::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 vtkCompositeDataDisplayAttributes * vtkCompositeDataDisplayAttributes::SafeDownCast ( vtkObjectBase *  o )

static

NewInstanceInternal()

virtual vtkObjectBase * vtkCompositeDataDisplayAttributes::NewInstanceInternal ( ) const

protectedvirtual

NewInstance()

vtkCompositeDataDisplayAttributes * vtkCompositeDataDisplayAttributes::NewInstance

(

)

const

PrintSelf()

void vtkCompositeDataDisplayAttributes::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.

HasBlockVisibilities()

bool vtkCompositeDataDisplayAttributes::HasBlockVisibilities

(

)

const

Returns true if any block has any block visibility is set.

SetBlockVisibility()

void vtkCompositeDataDisplayAttributes::SetBlockVisibility	(	vtkDataObject *	data_object,
		bool	visible
	)

Set/get the visibility for the block with data_object.

GetBlockVisibility()

bool vtkCompositeDataDisplayAttributes::GetBlockVisibility

(

vtkDataObject *

data_object

)

const

Set/get the visibility for the block with data_object.

HasBlockVisibility()

bool vtkCompositeDataDisplayAttributes::HasBlockVisibility

(

vtkDataObject *

data_object

)

const

Returns true if the block with the given data_object has a visibility set.

RemoveBlockVisibility()

void vtkCompositeDataDisplayAttributes::RemoveBlockVisibility

(

vtkDataObject *

data_object

)

Removes the block visibility flag for the block with data_object.

RemoveBlockVisibilities()

void vtkCompositeDataDisplayAttributes::RemoveBlockVisibilities

(

)

Removes all block visibility flags.

This effectively sets the visibility for all blocks to true.

HasBlockPickabilities()

bool vtkCompositeDataDisplayAttributes::HasBlockPickabilities

(

)

const

Returns true if any block has any block pickability is set.

SetBlockPickability()

void vtkCompositeDataDisplayAttributes::SetBlockPickability	(	vtkDataObject *	data_object,
		bool	visible
	)

Set/get the pickability for the block with data_object.

GetBlockPickability()

bool vtkCompositeDataDisplayAttributes::GetBlockPickability

(

vtkDataObject *

data_object

)

const

Set/get the pickability for the block with data_object.

HasBlockPickability()

bool vtkCompositeDataDisplayAttributes::HasBlockPickability

(

vtkDataObject *

data_object

)

const

Returns true if the block with the given data_object has a pickability set.

RemoveBlockPickability()

void vtkCompositeDataDisplayAttributes::RemoveBlockPickability

(

vtkDataObject *

data_object

)

Removes the block pickability flag for the block with data_object.

RemoveBlockPickabilities()

void vtkCompositeDataDisplayAttributes::RemoveBlockPickabilities

(

)

Removes all block pickability flags.

This effectively sets the pickability for all blocks to true.

SetBlockColor()

void vtkCompositeDataDisplayAttributes::SetBlockColor	(	vtkDataObject *	data_object,
		const double	color[3]
	)

Set/get the color for the block with data_object.

GetBlockColor() [1/2]

void vtkCompositeDataDisplayAttributes::GetBlockColor	(	vtkDataObject *	data_object,
		double	color[3]
	)		const

Set/get the color for the block with data_object.

GetBlockColor() [2/2]

vtkColor3d vtkCompositeDataDisplayAttributes::GetBlockColor

(

vtkDataObject *

data_object

)

const

Set/get the color for the block with data_object.

HasBlockColors()

bool vtkCompositeDataDisplayAttributes::HasBlockColors

(

)

const

Returns true if any block has any block color is set.

HasBlockColor()

bool vtkCompositeDataDisplayAttributes::HasBlockColor

(

vtkDataObject *

data_object

)

const

Returns true if the block with the given data_object has a color.

RemoveBlockColor()

void vtkCompositeDataDisplayAttributes::RemoveBlockColor

(

vtkDataObject *

data_object

)

Removes the block color for the block with data_object.

RemoveBlockColors()

void vtkCompositeDataDisplayAttributes::RemoveBlockColors

(

)

Removes all block colors.

SetBlockOpacity()

void vtkCompositeDataDisplayAttributes::SetBlockOpacity	(	vtkDataObject *	data_object,
		double	opacity
	)

Set/get the opacity for the block with data_object.

GetBlockOpacity()

double vtkCompositeDataDisplayAttributes::GetBlockOpacity

(

vtkDataObject *

data_object

)

const

Set/get the opacity for the block with data_object.

HasBlockOpacities()

bool vtkCompositeDataDisplayAttributes::HasBlockOpacities

(

)

const

Returns true if any block has an opacity set.

HasBlockOpacity()

bool vtkCompositeDataDisplayAttributes::HasBlockOpacity

(

vtkDataObject *

data_object

)

const

Returns true if the block with data_object has an opacity set.

RemoveBlockOpacity()

void vtkCompositeDataDisplayAttributes::RemoveBlockOpacity

(

vtkDataObject *

data_object

)

Removes the set opacity for the block with data_object.

RemoveBlockOpacities()

void vtkCompositeDataDisplayAttributes::RemoveBlockOpacities

(

)

Removes all block opacities.

SetBlockMaterial()

void vtkCompositeDataDisplayAttributes::SetBlockMaterial	(	vtkDataObject *	data_object,
		const std::string &	material
	)

Set/get the material for the block with data_object.

Only rendering backends that support advanced materials need to respect these.

GetBlockMaterial()

const std::string & vtkCompositeDataDisplayAttributes::GetBlockMaterial

(

vtkDataObject *

data_object

)

const

Set/get the material for the block with data_object.

Only rendering backends that support advanced materials need to respect these.

HasBlockMaterials()

bool vtkCompositeDataDisplayAttributes::HasBlockMaterials

(

)

const

Returns true if any block has an material set.

HasBlockMaterial()

bool vtkCompositeDataDisplayAttributes::HasBlockMaterial

(

vtkDataObject *

data_object

)

const

Returns true if the block with data_object has an material set.

RemoveBlockMaterial()

void vtkCompositeDataDisplayAttributes::RemoveBlockMaterial

(

vtkDataObject *

data_object

)

Removes the set material for the block with data_object.

RemoveBlockMaterials()

void vtkCompositeDataDisplayAttributes::RemoveBlockMaterials

(

)

Removes all block materialss.

ComputeVisibleBounds()

static void vtkCompositeDataDisplayAttributes::ComputeVisibleBounds ( vtkCompositeDataDisplayAttributes *  cda, vtkDataObject *  dobj, double  bounds[6]  )

static

If the input dobj is a vtkCompositeDataSet, we will loop over the hierarchy recursively starting from initial index 0 and use only visible blocks, which is specified in the vtkCompositeDataDisplayAttributes cda, to compute the bounds.

DataObjectFromIndex()

static vtkDataObject * vtkCompositeDataDisplayAttributes::DataObjectFromIndex ( const unsigned int  flat_index, vtkDataObject *  parent_obj, unsigned int  current_flat_index = 0  )

static

Get the DataObject corresponding to the node with index flat_index under parent_obj.

Traverses the entire hierarchy recursively.

VisitVisibilities()

void vtkCompositeDataDisplayAttributes::VisitVisibilities ( std::function< bool(vtkDataObject *, bool)>  visitor )

inline

Definition at line 227 of file vtkCompositeDataDisplayAttributes.h.

---

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

• Rendering/Core/vtkCompositeDataDisplayAttributes.h