vtkBlockProperties Class Reference

#include <vtkBlockProperties.h>

Detailed Description

Per-block appearance for a representation of composite data.

vtkBlockProperties is the part of a representation that says how individual blocks of a composite dataset are drawn, differently from the rest: whether a block is drawn at all, and in what color and opacity. A representation owns one and hands it out through vtkSurfaceRepresentation::GetBlocks().

Example usage:

rep->GetBlocks()->SetVisibility(2, false);
rep->GetBlocks()->SetColor(3, 0.8, 0.2, 0.2);
rep->GetBlocks()->Reset();

The same in Python:

rep.blocks.SetVisibility(2, False)
rep.blocks.SetColor(3, 0.8, 0.2, 0.2)

Blocks are addressed by flat index, the same index composite dataset iteration and the vtkCompositeIndex array use. An index only means anything against real data, because it has to be walked to find the block it names, so these bring the representation up to date before resolving one and warn rather than guess when there is nothing to resolve against. That resolution is the reason this is an object rather than a handful of methods: it is a step every one of them would otherwise have to remember.

A block with nothing set for it is drawn like the rest of the representation. Reset() puts every block back to that.

See also

vtkSurfaceRepresentation vtkCompositeDataDisplayAttributes

Definition at line 53 of file vtkBlockProperties.h.

Inheritance diagram for vtkBlockProperties:

Collaboration diagram for vtkBlockProperties:

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.
vtkBlockProperties *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
void	Reset ()
	Forget everything set per block, so that every block is drawn like the rest of the representation again.
vtkCompositeDataDisplayAttributes *	GetDisplayAttributes ()
	The attributes object these are stored in, for what is not covered here: per-block textures, scalar mode and field data tuple ids.
void	SetVisibility (unsigned int index, bool visible)
	Whether the block at index is drawn.
bool	GetVisibility (unsigned int index)
	Whether the block at index is drawn.
void	SetColor (unsigned int index, double r, double g, double b)
	The color of the block at index, in place of the color the whole representation is drawn in.
void	GetColor (unsigned int index, double color[3])
	The color of the block at index, in place of the color the whole representation is drawn in.
void	SetOpacity (unsigned int index, double opacity)
	How opaque the block at index is, in place of the representation's own opacity.
double	GetOpacity (unsigned int index)
	How opaque the block at index is, in place of the representation's own opacity.
void	SetMapper (vtkCompositePolyDataMapper *mapper)
	The mapper these properties are applied to, and the representation that has to be up to date before a flat index can be resolved against its data.
void	SetRepresentation (vtkAlgorithm *representation)
	The mapper these properties are applied to, and the representation that has to be up to date before a flat index can be resolved against its data.
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 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 vtkBlockProperties *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
static vtkBlockProperties *	SafeDownCast (vtkObjectBase *o)
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
	vtkBlockProperties ()
	~vtkBlockProperties () 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	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
std::string	ObjectName
Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Member Typedef Documentation

Superclass

typedef vtkObject vtkBlockProperties::Superclass

Definition at line 57 of file vtkBlockProperties.h.

Constructor & Destructor Documentation

vtkBlockProperties()

vtkBlockProperties::vtkBlockProperties ( )

protected

~vtkBlockProperties()

vtkBlockProperties::~vtkBlockProperties ( )

overrideprotected

Member Function Documentation

New()

vtkBlockProperties * vtkBlockProperties::New ( )

static

IsTypeOf()

vtkTypeBool vtkBlockProperties::IsTypeOf ( const char * type )

static

IsA()

virtual vtkTypeBool vtkBlockProperties::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()

vtkBlockProperties * vtkBlockProperties::SafeDownCast ( vtkObjectBase * o )

static

NewInstanceInternal()

virtual vtkObjectBase * vtkBlockProperties::NewInstanceInternal ( ) const

protectedvirtual

NewInstance()

vtkBlockProperties * vtkBlockProperties::NewInstance

(

)

const

PrintSelf()

void vtkBlockProperties::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 vtkObjectBase.

SetVisibility()

void vtkBlockProperties::SetVisibility	(	unsigned int	index,
		bool	visible )

Whether the block at index is drawn.

A block nothing has been said about is drawn, so this only ever needs setting to hide one.

GetVisibility()

bool vtkBlockProperties::GetVisibility

(

unsigned int

index

)

Whether the block at index is drawn.

A block nothing has been said about is drawn, so this only ever needs setting to hide one.

SetColor()

void vtkBlockProperties::SetColor	(	unsigned int	index,
		double	r,
		double	g,
		double	b )

The color of the block at index, in place of the color the whole representation is drawn in.

Has no effect while the representation is coloring by an array.

GetColor()

void vtkBlockProperties::GetColor	(	unsigned int	index,
		double	color[3] )

The color of the block at index, in place of the color the whole representation is drawn in.

Has no effect while the representation is coloring by an array.

SetOpacity()

void vtkBlockProperties::SetOpacity	(	unsigned int	index,
		double	opacity )

How opaque the block at index is, in place of the representation's own opacity.

GetOpacity()

double vtkBlockProperties::GetOpacity

(

unsigned int

index

)

How opaque the block at index is, in place of the representation's own opacity.

Reset()

void vtkBlockProperties::Reset

(

)

Forget everything set per block, so that every block is drawn like the rest of the representation again.

GetDisplayAttributes()

vtkCompositeDataDisplayAttributes * vtkBlockProperties::GetDisplayAttributes

(

)

The attributes object these are stored in, for what is not covered here: per-block textures, scalar mode and field data tuple ids.

Note that it is keyed by data object rather than by index, which is the difference this class exists to paper over.

SetMapper()

void vtkBlockProperties::SetMapper

(

vtkCompositePolyDataMapper *

mapper

)

The mapper these properties are applied to, and the representation that has to be up to date before a flat index can be resolved against its data.

Both are set by the representation that owns this object; there is no reason for anything else to call them. The representation is held weakly, so an object kept alive after it has gone does nothing rather than follow a dangling pointer.

SetRepresentation()

void vtkBlockProperties::SetRepresentation

(

vtkAlgorithm *

representation

)

The mapper these properties are applied to, and the representation that has to be up to date before a flat index can be resolved against its data.

Both are set by the representation that owns this object; there is no reason for anything else to call them. The representation is held weakly, so an object kept alive after it has gone does nothing rather than follow a dangling pointer.

---

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

• Views/Scivis/vtkBlockProperties.h