vtkCompositeDataDisplayAttributesLegacy Class Reference

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

#include <vtkCompositeDataDisplayAttributesLegacy.h>

Inheritance diagram for vtkCompositeDataDisplayAttributesLegacy:

Collaboration diagram for vtkCompositeDataDisplayAttributesLegacy:

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.
vtkCompositeDataDisplayAttributesLegacy *	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 (unsigned int flat_index) const
	Returns true if the block with the given flat_index has a visibility set.
void	RemoveBlockVisibility (unsigned int flat_index)
	Removes the block visibility flag for the block with flat_index.
void	RemoveBlockVisibilities ()
	Removes all block visibility flags.
bool	HasBlockPickabilities () const
	Returns true if any block has any block visibility is set.
bool	HasBlockPickability (unsigned int flat_index) const
	Returns true if the block with the given flat_index has a visibility set.
void	RemoveBlockPickability (unsigned int flat_index)
	Removes the block visibility flag for the block with flat_index.
void	RemoveBlockPickabilities ()
	Removes all block visibility flags.
bool	HasBlockColors () const
	Returns true if any block has any block color is set.
bool	HasBlockColor (unsigned int flat_index) const
	Returns true if the block with the given flat_index has a color.
void	RemoveBlockColor (unsigned int flat_index)
	Removes the block color for the block with flat_index.
void	RemoveBlockColors ()
	Removes all block colors.
bool	HasBlockOpacities () const
	Returns true if any block has an opacity set.
bool	HasBlockOpacity (unsigned int flat_index) const
	Returns true if the block with flat_index has an opacity set.
void	RemoveBlockOpacity (unsigned int flat_index)
	Removes the set opacity for the block with flat_index.
void	RemoveBlockOpacities ()
	Removes all block opacities.
void	SetBlockVisibility (unsigned int flat_index, bool visible)
	Set/get the visibility for the block with flat_index.
bool	GetBlockVisibility (unsigned int flat_index) const
	Set/get the visibility for the block with flat_index.
void	SetBlockPickability (unsigned int flat_index, bool visible)
	Set/get the visibility for the block with flat_index.
bool	GetBlockPickability (unsigned int flat_index) const
	Set/get the visibility for the block with flat_index.
void	SetBlockColor (unsigned int flat_index, const double color[3])
	Set/get the color for the block with flat_index.
void	GetBlockColor (unsigned int flat_index, double color[3]) const
	Set/get the color for the block with flat_index.
vtkColor3d	GetBlockColor (unsigned int flat_index) const
	Set/get the color for the block with flat_index.
void	SetBlockOpacity (unsigned int flat_index, double opacity)
	Set/get the opacity for the block with flat_index.
double	GetBlockOpacity (unsigned int flat_index) const
	Set/get the opacity for the block with flat_index.
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 vtkCompositeDataDisplayAttributesLegacy *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
static vtkCompositeDataDisplayAttributesLegacy *	SafeDownCast (vtkObjectBase *o)
static void	ComputeVisibleBounds (vtkCompositeDataDisplayAttributesLegacy *cda, vtkDataObject *dobj, double bounds[6])
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
	vtkCompositeDataDisplayAttributesLegacy ()
	~vtkCompositeDataDisplayAttributesLegacy () 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 vtkCompositeDataDisplayAttributesLegacy class stores display attributes for individual blocks in a multi-block dataset. Attributes are mapped to blocks through their flat-index; This is the mechanism used in legacy OpenGL classes.

Definition at line 38 of file vtkCompositeDataDisplayAttributesLegacy.h.

Member Typedef Documentation

Superclass

typedef vtkObject vtkCompositeDataDisplayAttributesLegacy::Superclass

Definition at line 42 of file vtkCompositeDataDisplayAttributesLegacy.h.

Constructor & Destructor Documentation

vtkCompositeDataDisplayAttributesLegacy()

vtkCompositeDataDisplayAttributesLegacy::vtkCompositeDataDisplayAttributesLegacy ( )

protected

~vtkCompositeDataDisplayAttributesLegacy()

vtkCompositeDataDisplayAttributesLegacy::~vtkCompositeDataDisplayAttributesLegacy ( )

overrideprotected

Member Function Documentation

New()

static vtkCompositeDataDisplayAttributesLegacy * vtkCompositeDataDisplayAttributesLegacy::New ( )

static

IsTypeOf()

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

static

IsA()

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

static

NewInstanceInternal()

virtual vtkObjectBase * vtkCompositeDataDisplayAttributesLegacy::NewInstanceInternal ( ) const

protectedvirtual

NewInstance()

vtkCompositeDataDisplayAttributesLegacy * vtkCompositeDataDisplayAttributesLegacy::NewInstance

(

)

const

PrintSelf()

void vtkCompositeDataDisplayAttributesLegacy::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 vtkCompositeDataDisplayAttributesLegacy::HasBlockVisibilities

(

)

const

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

SetBlockVisibility()

void vtkCompositeDataDisplayAttributesLegacy::SetBlockVisibility	(	unsigned int	flat_index,
		bool	visible
	)

Set/get the visibility for the block with flat_index.

GetBlockVisibility()

bool vtkCompositeDataDisplayAttributesLegacy::GetBlockVisibility

(

unsigned int

flat_index

)

const

Set/get the visibility for the block with flat_index.

HasBlockVisibility()

bool vtkCompositeDataDisplayAttributesLegacy::HasBlockVisibility

(

unsigned int

flat_index

)

const

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

RemoveBlockVisibility()

void vtkCompositeDataDisplayAttributesLegacy::RemoveBlockVisibility

(

unsigned int

flat_index

)

Removes the block visibility flag for the block with flat_index.

RemoveBlockVisibilities()

void vtkCompositeDataDisplayAttributesLegacy::RemoveBlockVisibilities

(

)

Removes all block visibility flags.

The effectively sets the visibility for all blocks to true.

HasBlockPickabilities()

bool vtkCompositeDataDisplayAttributesLegacy::HasBlockPickabilities

(

)

const

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

SetBlockPickability()

void vtkCompositeDataDisplayAttributesLegacy::SetBlockPickability	(	unsigned int	flat_index,
		bool	visible
	)

Set/get the visibility for the block with flat_index.

GetBlockPickability()

bool vtkCompositeDataDisplayAttributesLegacy::GetBlockPickability

(

unsigned int

flat_index

)

const

Set/get the visibility for the block with flat_index.

HasBlockPickability()

bool vtkCompositeDataDisplayAttributesLegacy::HasBlockPickability

(

unsigned int

flat_index

)

const

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

RemoveBlockPickability()

void vtkCompositeDataDisplayAttributesLegacy::RemoveBlockPickability

(

unsigned int

flat_index

)

Removes the block visibility flag for the block with flat_index.

RemoveBlockPickabilities()

void vtkCompositeDataDisplayAttributesLegacy::RemoveBlockPickabilities

(

)

Removes all block visibility flags.

The effectively sets the visibility for all blocks to true.

SetBlockColor()

void vtkCompositeDataDisplayAttributesLegacy::SetBlockColor	(	unsigned int	flat_index,
		const double	color[3]
	)

Set/get the color for the block with flat_index.

GetBlockColor() [1/2]

void vtkCompositeDataDisplayAttributesLegacy::GetBlockColor	(	unsigned int	flat_index,
		double	color[3]
	)		const

Set/get the color for the block with flat_index.

GetBlockColor() [2/2]

vtkColor3d vtkCompositeDataDisplayAttributesLegacy::GetBlockColor

(

unsigned int

flat_index

)

const

Set/get the color for the block with flat_index.

HasBlockColors()

bool vtkCompositeDataDisplayAttributesLegacy::HasBlockColors

(

)

const

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

HasBlockColor()

bool vtkCompositeDataDisplayAttributesLegacy::HasBlockColor

(

unsigned int

flat_index

)

const

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

RemoveBlockColor()

void vtkCompositeDataDisplayAttributesLegacy::RemoveBlockColor

(

unsigned int

flat_index

)

Removes the block color for the block with flat_index.

RemoveBlockColors()

void vtkCompositeDataDisplayAttributesLegacy::RemoveBlockColors

(

)

Removes all block colors.

SetBlockOpacity()

void vtkCompositeDataDisplayAttributesLegacy::SetBlockOpacity	(	unsigned int	flat_index,
		double	opacity
	)

Set/get the opacity for the block with flat_index.

GetBlockOpacity()

double vtkCompositeDataDisplayAttributesLegacy::GetBlockOpacity

(

unsigned int

flat_index

)

const

Set/get the opacity for the block with flat_index.

HasBlockOpacities()

bool vtkCompositeDataDisplayAttributesLegacy::HasBlockOpacities

(

)

const

Returns true if any block has an opacity set.

HasBlockOpacity()

bool vtkCompositeDataDisplayAttributesLegacy::HasBlockOpacity

(

unsigned int

flat_index

)

const

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

RemoveBlockOpacity()

void vtkCompositeDataDisplayAttributesLegacy::RemoveBlockOpacity

(

unsigned int

flat_index

)

Removes the set opacity for the block with flat_index.

RemoveBlockOpacities()

void vtkCompositeDataDisplayAttributesLegacy::RemoveBlockOpacities

(

)

Removes all block opacities.

ComputeVisibleBounds()

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

static

---

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

• Rendering/Core/vtkCompositeDataDisplayAttributesLegacy.h