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

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

#include <vtkCompositeDataDisplayAttributesLegacy.h>

Inheritance diagram for vtkCompositeDataDisplayAttributesLegacy:
[legend]
Collaboration diagram for vtkCompositeDataDisplayAttributesLegacy:
[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...
 
vtkCompositeDataDisplayAttributesLegacyNewInstance () 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 (unsigned int flat_index, bool visible)
 Set/get the visibility for the block with flat_index. More...
 
bool GetBlockVisibility (unsigned int flat_index) const
 
bool HasBlockVisibility (unsigned int flat_index) const
 Returns true if the block with the given flat_index has a visibility set. More...
 
void RemoveBlockVisibility (unsigned int flat_index)
 Removes the block visibility flag for the block with flat_index. More...
 
void RemoveBlockVisibilities ()
 Removes all block visibility flags. More...
 
void RemoveBlockVisibilites ()
 
bool HasBlockPickabilities () const
 Returns true if any block has any block visibility is set. More...
 
void SetBlockPickability (unsigned int flat_index, bool visible)
 Set/get the visibility for the block with flat_index. More...
 
bool GetBlockPickability (unsigned int flat_index) const
 
bool HasBlockPickability (unsigned int flat_index) const
 Returns true if the block with the given flat_index has a visibility set. More...
 
void RemoveBlockPickability (unsigned int flat_index)
 Removes the block visibility flag for the block with flat_index. More...
 
void RemoveBlockPickabilities ()
 Removes all block visibility flags. 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
 
vtkColor3d GetBlockColor (unsigned int flat_index) const
 
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...
 
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
 
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...
 
- 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 vtkCompositeDataDisplayAttributesLegacyNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkCompositeDataDisplayAttributesLegacySafeDownCast (vtkObjectBase *o)
 
static void ComputeVisibleBounds (vtkCompositeDataDisplayAttributesLegacy *cda, vtkDataObject *dobj, double bounds[6])
 
- 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
 
 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. 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 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

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

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

◆ RemoveBlockVisibilites()

void vtkCompositeDataDisplayAttributesLegacy::RemoveBlockVisibilites ( )

◆ 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

◆ 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

◆ GetBlockColor() [2/2]

vtkColor3d vtkCompositeDataDisplayAttributesLegacy::GetBlockColor ( unsigned int  flat_index) const

◆ 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

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