helper object to manage the visibility of points and cells More...

#include <vtkStructuredVisibilityConstraint.h>

Inheritance diagram for vtkStructuredVisibilityConstraint:

Collaboration diagram for vtkStructuredVisibilityConstraint:

Public Types
typedef vtkObject	Superclass
Public Member Functions
virtual int	IsA (const char *type)
vtkStructuredVisibilityConstraint *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
unsigned char	IsVisible (vtkIdType id)
void	Blank (vtkIdType id)
void	UnBlank (vtkIdType id)
void	Initialize (int dims[3])
void	Allocate ()
void	ShallowCopy (vtkStructuredVisibilityConstraint *src)
void	DeepCopy (vtkStructuredVisibilityConstraint *src)

virtual int *	GetDimensions ()
virtual void	GetDimensions (int data[3])

void	SetVisibilityById (vtkUnsignedCharArray *vis)
virtual vtkUnsignedCharArray *	GetVisibilityById ()

unsigned char	IsConstrained ()
Static Public Member Functions
static vtkStructuredVisibilityConstraint *	New ()
static int	IsTypeOf (const char *type)
static vtkStructuredVisibilityConstraint *	SafeDownCast (vtkObjectBase *o)
Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkStructuredVisibilityConstraint ()
	~vtkStructuredVisibilityConstraint ()
Protected Attributes
vtkUnsignedCharArray *	VisibilityById
int	Dimensions [3]
vtkIdType	NumberOfIds
unsigned char	Initialized

Detailed Description

helper object to manage the visibility of points and cells

vtkStructuredVisibilityConstraint is a general class to manage a list of points/cell marked as invalid or invisible. Currently, it does this by maintaining an unsigned char array associated with points/cells. To conserve memory, this array is allocated only when it is needed (when Blank() is called the first time). Make sure to call Initialize() with the right dimensions before calling any methods that set/get visibility.

Definition at line 36 of file vtkStructuredVisibilityConstraint.h.

Member Typedef Documentation

typedef vtkObject vtkStructuredVisibilityConstraint::Superclass

Reimplemented from vtkObject.

Definition at line 41 of file vtkStructuredVisibilityConstraint.h.

Constructor & Destructor Documentation

vtkStructuredVisibilityConstraint::vtkStructuredVisibilityConstraint ( ) [protected]

vtkStructuredVisibilityConstraint::~vtkStructuredVisibilityConstraint ( ) [protected]

Member Function Documentation

static vtkStructuredVisibilityConstraint* vtkStructuredVisibilityConstraint::New ( ) [static]

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

Reimplemented from vtkObject.

static int vtkStructuredVisibilityConstraint::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 vtkStructuredVisibilityConstraint::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 vtkStructuredVisibilityConstraint* vtkStructuredVisibilityConstraint::SafeDownCast ( vtkObjectBase * o ) [static]

Reimplemented from vtkObject.

virtual vtkObjectBase* vtkStructuredVisibilityConstraint::NewInstanceInternal ( ) const [protected, virtual]

Reimplemented from vtkObject.

vtkStructuredVisibilityConstraint* vtkStructuredVisibilityConstraint::NewInstance ( ) const

Reimplemented from vtkObject.

void vtkStructuredVisibilityConstraint::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.

unsigned char vtkStructuredVisibilityConstraint::IsVisible ( vtkIdType id ) [inline]

Returns 1 is the point/cell is visible, 0 otherwise.

Definition at line 121 of file vtkStructuredVisibilityConstraint.h.

void vtkStructuredVisibilityConstraint::Blank ( vtkIdType id ) [inline]

Sets the visibility flag of the given point/cell off. The first time blank is called, a new visibility array is created if it doesn't exist.

Definition at line 129 of file vtkStructuredVisibilityConstraint.h.

void vtkStructuredVisibilityConstraint::UnBlank ( vtkIdType id ) [inline]

Sets the visibility flag of the given point/cell on.

Definition at line 146 of file vtkStructuredVisibilityConstraint.h.

virtual int* vtkStructuredVisibilityConstraint::GetDimensions ( ) [virtual]

Get the dimensions used to initialize the object.

virtual void vtkStructuredVisibilityConstraint::GetDimensions ( int data[3] ) [virtual]

Get the dimensions used to initialize the object.

void vtkStructuredVisibilityConstraint::Initialize ( int dims[3] ) [inline]

Set the dimensions and set the Initialized flag to 1. Once an object is initialized, it's dimensions can not be changed anymore.

Definition at line 157 of file vtkStructuredVisibilityConstraint.h.

void vtkStructuredVisibilityConstraint::Allocate ( ) [inline]

Allocates the internal visibility data-structure iff the object has been initialized.

Definition at line 108 of file vtkStructuredVisibilityConstraint.h.

void vtkStructuredVisibilityConstraint::SetVisibilityById ( vtkUnsignedCharArray * vis )

Set/Get the array used to store the visibility flags.

virtual vtkUnsignedCharArray* vtkStructuredVisibilityConstraint::GetVisibilityById ( ) [virtual]

Set/Get the array used to store the visibility flags.

void vtkStructuredVisibilityConstraint::ShallowCopy ( vtkStructuredVisibilityConstraint * src )

Copies the dimensions, the visibility array pointer and the initialized flag.

void vtkStructuredVisibilityConstraint::DeepCopy ( vtkStructuredVisibilityConstraint * src )

Copies the dimensions, the visibility array and the initialized flag.

unsigned char vtkStructuredVisibilityConstraint::IsConstrained ( ) [inline]

Returns 0 if there is no visibility array (all cells/points are visible), 0 otherwise.

Definition at line 84 of file vtkStructuredVisibilityConstraint.h.

Member Data Documentation

vtkUnsignedCharArray* vtkStructuredVisibilityConstraint::VisibilityById [protected]

Definition at line 94 of file vtkStructuredVisibilityConstraint.h.

int vtkStructuredVisibilityConstraint::Dimensions[3] [protected]

Definition at line 95 of file vtkStructuredVisibilityConstraint.h.

vtkIdType vtkStructuredVisibilityConstraint::NumberOfIds [protected]

Definition at line 96 of file vtkStructuredVisibilityConstraint.h.

unsigned char vtkStructuredVisibilityConstraint::Initialized [protected]

Definition at line 97 of file vtkStructuredVisibilityConstraint.h.

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

dox/Common/DataModel/vtkStructuredVisibilityConstraint.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation