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 int	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

vtkCompositeDataDisplayAttributes *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

bool	HasBlockVisibilities () const
	Returns true if any block has any block visibility is set. More...

bool	HasBlockVisibility (unsigned int flat_index) const
	Returns true if the block with the given flat_index has a visiblity set. More...

void	RemoveBlockVisibility (unsigned int flat_index)
	Removes the block visibility flag for the block with flat_index. More...

void	RemoveBlockVisibilites ()
	Removes all block visibility flags. More...

bool	HasBlockColors () const
	Returns true if any block has any block color is set. More...

bool	HasBlockColor (unsigned int flat_index) const
	Returns true if the block with the given `flat_index` has a color. More...

void	RemoveBlockColor (unsigned int flat_index)
	Removes the block color for the block with `flat_index`. More...

void	RemoveBlockColors ()
	Removes all block colors. More...

bool	HasBlockOpacities () const
	Returns true if any block has an opacity set. More...

bool	HasBlockOpacity (unsigned int flat_index) const
	Returns true if the block with flat_index has an opacity set. More...

void	RemoveBlockOpacity (unsigned int flat_index)
	Removes the set opacity for the block with flat_index. More...

void	RemoveBlockOpacities ()
	Removes all block opacities. More...


void	SetBlockVisibility (unsigned int flat_index, bool visible)
	Set/get the visibility for the block with `flat_index`. More...

bool	GetBlockVisibility (unsigned int flat_index) const
	Set/get the visibility for the block with `flat_index`. More...


void	SetBlockColor (unsigned int flat_index, const double color[3])
	Set/get the color for the block with `flat_index`. More...

void	GetBlockColor (unsigned int flat_index, double color[3]) const
	Set/get the color for the block with `flat_index`. More...

vtkColor3d	GetBlockColor (unsigned int flat_index) const
	Set/get the color for the block with `flat_index`. More...


void	SetBlockOpacity (unsigned int flat_index, double opacity)
	Set/get the opacity for the block with flat_index. More...

double	GetBlockOpacity (unsigned int flat_index) const
	Set/get the opacity for the block with flat_index. More...

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on. More...

virtual void	DebugOff ()
	Turn debugging output off. More...

bool	GetDebug ()
	Get the value of the debug flag. More...

void	SetDebug (bool debugFlag)
	Set the value of the debug flag. More...

virtual void	Modified ()
	Update the modification time for this object. More...

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time. More...

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	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. More...

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

int	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

int	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

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. More...

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. More...

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. More...

int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not. More...

int	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not. More...

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string. More...

virtual void	Delete ()
	Delete a VTK object. More...

virtual void	FastDelete ()
	Delete a reference to this object. More...

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream. More...

virtual void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object). More...

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object). More...

int	GetReferenceCount ()
	Return the current reference count of this object. More...

void	SetReferenceCount (int)
	Sets the reference count. More...

void	PrintRevisions (ostream &)
	Legacy. More...

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

Static Public Member Functions
static vtkCompositeDataDisplayAttributes *	New ()

static int	IsTypeOf (const char *type)

static vtkCompositeDataDisplayAttributes *	SafeDownCast (vtkObjectBase *o)

static void	ComputeVisibleBounds (vtkCompositeDataDisplayAttributes 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. More...

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes. More...

static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

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. More...

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkCompositeDataDisplayAttributes ()

	~vtkCompositeDataDisplayAttributes ()

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=NULL)
	These methods allow a command to exclusively grab all events. More...

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events. More...

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Additional Inherited Members
Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	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.

Tests:: vtkCompositeDataDisplayAttributes (Tests)

Definition at line 39 of file vtkCompositeDataDisplayAttributes.h.

Member Typedef Documentation

typedef vtkObject vtkCompositeDataDisplayAttributes::Superclass

Definition at line 43 of file vtkCompositeDataDisplayAttributes.h.

Constructor & Destructor Documentation

vtkCompositeDataDisplayAttributes::vtkCompositeDataDisplayAttributes ( )

protected

vtkCompositeDataDisplayAttributes::~vtkCompositeDataDisplayAttributes ( )

protected

Member Function Documentation

static vtkCompositeDataDisplayAttributes* vtkCompositeDataDisplayAttributes::New ( )

static

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

static

virtual int 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.

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

static

virtual vtkObjectBase* vtkCompositeDataDisplayAttributes::NewInstanceInternal ( ) const

protectedvirtual

vtkCompositeDataDisplayAttributes* vtkCompositeDataDisplayAttributes::NewInstance ( ) const

void vtkCompositeDataDisplayAttributes::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

virtual

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.

bool vtkCompositeDataDisplayAttributes::HasBlockVisibilities ( ) const

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

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

Set/get the visibility for the block with flat_index.

bool vtkCompositeDataDisplayAttributes::GetBlockVisibility ( unsigned int flat_index ) const

Set/get the visibility for the block with flat_index.

bool vtkCompositeDataDisplayAttributes::HasBlockVisibility ( unsigned int flat_index ) const

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

void vtkCompositeDataDisplayAttributes::RemoveBlockVisibility ( unsigned int flat_index )

Removes the block visibility flag for the block with flat_index.

void vtkCompositeDataDisplayAttributes::RemoveBlockVisibilites ( )

Removes all block visibility flags.

The effectively sets the visibility for all blocks to true.

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

Set/get the color for the block with flat_index.

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

Set/get the color for the block with flat_index.

vtkColor3d vtkCompositeDataDisplayAttributes::GetBlockColor ( unsigned int flat_index ) const

Set/get the color for the block with flat_index.

bool vtkCompositeDataDisplayAttributes::HasBlockColors ( ) const

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

bool vtkCompositeDataDisplayAttributes::HasBlockColor ( unsigned int flat_index ) const

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

void vtkCompositeDataDisplayAttributes::RemoveBlockColor ( unsigned int flat_index )

Removes the block color for the block with flat_index.

void vtkCompositeDataDisplayAttributes::RemoveBlockColors ( )

Removes all block colors.

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

Set/get the opacity for the block with flat_index.

double vtkCompositeDataDisplayAttributes::GetBlockOpacity ( unsigned int flat_index ) const

Set/get the opacity for the block with flat_index.

bool vtkCompositeDataDisplayAttributes::HasBlockOpacities ( ) const

Returns true if any block has an opacity set.

bool vtkCompositeDataDisplayAttributes::HasBlockOpacity ( unsigned int flat_index ) const

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

void vtkCompositeDataDisplayAttributes::RemoveBlockOpacity ( unsigned int flat_index )

Removes the set opacity for the block with flat_index.

void vtkCompositeDataDisplayAttributes::RemoveBlockOpacities ( )

Removes all block opacities.

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

static

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

/home/demarle/Builds/VTK/release/Utilities/Doxygen/dox/Rendering/Core/vtkCompositeDataDisplayAttributes.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation