VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkCompositeDataDisplayAttributes Class Reference

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

#include <vtkCompositeDataDisplayAttributes.h>

Inheritance diagram for vtkCompositeDataDisplayAttributes:
[legend]
Collaboration diagram for vtkCompositeDataDisplayAttributes:
[legend]

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. More...
 
vtkCompositeDataDisplayAttributesNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 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...
 
void SetBlockVisibility (vtkDataObject *data_object, bool visible)
 Set/get the visibility for the block with data_object. More...
 
bool GetBlockVisibility (vtkDataObject *data_object) const
 
bool HasBlockVisibility (vtkDataObject *data_object) const
 Returns true if the block with the given data_object has a visibility set. More...
 
void RemoveBlockVisibility (vtkDataObject *data_object)
 Removes the block visibility flag for the block with data_object. More...
 
void RemoveBlockVisibilities ()
 Removes all block visibility flags. More...
 
void RemoveBlockVisibilites ()
 
bool HasBlockPickabilities () const
 Returns true if any block has any block pickability is set. More...
 
void SetBlockPickability (vtkDataObject *data_object, bool visible)
 Set/get the pickability for the block with data_object. More...
 
bool GetBlockPickability (vtkDataObject *data_object) const
 
bool HasBlockPickability (vtkDataObject *data_object) const
 Returns true if the block with the given data_object has a pickability set. More...
 
void RemoveBlockPickability (vtkDataObject *data_object)
 Removes the block pickability flag for the block with data_object. More...
 
void RemoveBlockPickabilities ()
 Removes all block pickability flags. More...
 
void SetBlockColor (vtkDataObject *data_object, const double color[3])
 Set/get the color for the block with data_object. More...
 
void GetBlockColor (vtkDataObject *data_object, double color[3]) const
 
vtkColor3d GetBlockColor (vtkDataObject *data_object) const
 
bool HasBlockColors () const
 Returns true if any block has any block color is set. More...
 
bool HasBlockColor (vtkDataObject *data_object) const
 Returns true if the block with the given data_object has a color. More...
 
void RemoveBlockColor (vtkDataObject *data_object)
 Removes the block color for the block with data_object. More...
 
void RemoveBlockColors ()
 Removes all block colors. More...
 
void SetBlockOpacity (vtkDataObject *data_object, double opacity)
 Set/get the opacity for the block with data_object. More...
 
double GetBlockOpacity (vtkDataObject *data_object) const
 
bool HasBlockOpacities () const
 Returns true if any block has an opacity set. More...
 
bool HasBlockOpacity (vtkDataObject *data_object) const
 Returns true if the block with data_object has an opacity set. More...
 
void RemoveBlockOpacity (vtkDataObject *data_object)
 Removes the set opacity for the block with data_object. More...
 
void RemoveBlockOpacities ()
 Removes all block opacities. More...
 
void SetBlockMaterial (vtkDataObject *data_object, const std::string &material)
 Set/get the material for the block with data_object. More...
 
const std::string & GetBlockMaterial (vtkDataObject *data_object) const
 
bool HasBlockMaterials () const
 Returns true if any block has an material set. More...
 
bool HasBlockMaterial (vtkDataObject *data_object) const
 Returns true if the block with data_object has an material set. More...
 
void RemoveBlockMaterial (vtkDataObject *data_object)
 Removes the set material for the block with data_object. More...
 
void RemoveBlockMaterials ()
 Removes all block materialss. More...
 
void VisitVisibilities (std::function< bool(vtkDataObject *, bool)> visitor)
 
- 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...
 
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)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
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)
 
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)
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- 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 PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
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...
 

Static Public Member Functions

static vtkCompositeDataDisplayAttributesNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkCompositeDataDisplayAttributesSafeDownCast (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. More...
 
static vtkDataObjectDataObjectFromIndex (const unsigned int flat_index, vtkDataObject *parent_obj, unsigned int &current_flat_index)
 Get the DataObject corresponding to the node with index flat_index under parent_obj. More...
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 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 ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- 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 vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () 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. More...
 
void InternalReleaseFocus ()
 
- 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
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.
Tests:
vtkCompositeDataDisplayAttributes (Tests)

Definition at line 43 of file vtkCompositeDataDisplayAttributes.h.

Member Typedef Documentation

◆ Superclass

Definition at line 47 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

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

◆ RemoveBlockVisibilites()

void vtkCompositeDataDisplayAttributes::RemoveBlockVisibilites ( )

◆ 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

◆ 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

◆ GetBlockColor() [2/2]

vtkColor3d vtkCompositeDataDisplayAttributes::GetBlockColor ( vtkDataObject data_object) const

◆ 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

◆ 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

◆ 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 
)
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 216 of file vtkCompositeDataDisplayAttributes.h.


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