vtkCompositeDataDisplayAttributes Class Reference

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

#include <vtkCompositeDataDisplayAttributes.h>

Inheritance diagram for vtkCompositeDataDisplayAttributes:

Collaboration diagram for vtkCompositeDataDisplayAttributes:

List of all members.

Public Types
typedef vtkObject	Superclass
Public Member Functions
virtual int	IsA (const char *type)
vtkCompositeDataDisplayAttributes *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
bool	HasBlockVisibilities () const
bool	HasBlockVisibility (unsigned int flat_index) const
void	RemoveBlockVisibility (unsigned int flat_index)
void	RemoveBlockVisibilites ()
bool	HasBlockColors () const
bool	HasBlockColor (unsigned int flat_index) const
void	RemoveBlockColor (unsigned int flat_index)
void	RemoveBlockColors ()
bool	HasBlockOpacities () const
bool	HasBlockOpacity (unsigned int flat_index) const
void	RemoveBlockOpacity (unsigned int flat_index)
void	RemoveBlockOpacities ()
void	SetBlockVisibility (unsigned int flat_index, bool visible)
bool	GetBlockVisibility (unsigned int flat_index) const
void	SetBlockColor (unsigned int flat_index, const double color[3])
void	GetBlockColor (unsigned int flat_index, double color[3]) const
vtkColor3d	GetBlockColor (unsigned int flat_index) const
void	SetBlockOpacity (unsigned int flat_index, double opacity)
double	GetBlockOpacity (unsigned int flat_index) const
Static Public Member Functions
static vtkCompositeDataDisplayAttributes *	New ()
static int	IsTypeOf (const char *type)
static vtkCompositeDataDisplayAttributes *	SafeDownCast (vtkObjectBase *o)
Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkCompositeDataDisplayAttributes ()
	~vtkCompositeDataDisplayAttributes ()

---

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 35 of file vtkCompositeDataDisplayAttributes.h.

---

Member Typedef Documentation

typedef vtkObject vtkCompositeDataDisplayAttributes::Superclass

Reimplemented from vtkObject.

Definition at line 39 of file vtkCompositeDataDisplayAttributes.h.

---

Constructor & Destructor Documentation

vtkCompositeDataDisplayAttributes::vtkCompositeDataDisplayAttributes

(

)

[protected]

vtkCompositeDataDisplayAttributes::~vtkCompositeDataDisplayAttributes

(

)

[protected]

---

Member Function Documentation

static vtkCompositeDataDisplayAttributes* vtkCompositeDataDisplayAttributes::New

(

)

[static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkObject.

static int vtkCompositeDataDisplayAttributes::IsTypeOf

(

const char *

name

)

[static]

Return 1 if this class type 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 vtkObject.

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

static vtkCompositeDataDisplayAttributes* vtkCompositeDataDisplayAttributes::SafeDownCast

(

vtkObjectBase *

o

)

[static]

Reimplemented from vtkObject.

virtual vtkObjectBase* vtkCompositeDataDisplayAttributes::NewInstanceInternal

(

)

const [protected, virtual]

Reimplemented from vtkObject.

vtkCompositeDataDisplayAttributes* vtkCompositeDataDisplayAttributes::NewInstance

(

)

const

Reimplemented from vtkObject.

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.

---

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

• dox/Rendering/Core/vtkCompositeDataDisplayAttributes.h