vtkStructuredVisibilityConstraint Class Reference

#include <vtkStructuredVisibilityConstraint.h>

Inheritance diagram for vtkStructuredVisibilityConstraint:

[legend]Collaboration diagram for vtkStructuredVisibilityConstraint:

[legend]List of all members.

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.

Created by:

Geveci, Berk

CVS contributions (if > 5%):

Geveci, Berk (95%)

CVS logs (CVSweb):

.h (/Common/vtkStructuredVisibilityConstraint.h)
.cxx (/Common/vtkStructuredVisibilityConstraint.cxx)

Definition at line 45 of file vtkStructuredVisibilityConstraint.h.

Public Types

typedef vtkObject Superclass

Public Member Functions

virtual const char * GetClassName ()

virtual int IsA (const char *type)

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

vtkStructuredVisibilityConstraint * New ()

int IsTypeOf (const char *type)

vtkStructuredVisibilityConstraint * SafeDownCast (vtkObject *o)

Protected Member Functions

vtkStructuredVisibilityConstraint ()

~vtkStructuredVisibilityConstraint ()

Protected Attributes

vtkUnsignedCharArray * VisibilityById

int Dimensions [3]

vtkIdType NumberOfIds

unsigned char Initialized

Member Typedef Documentation

typedef vtkObject vtkStructuredVisibilityConstraint::Superclass

Reimplemented from vtkObject.
Definition at line 50 of file vtkStructuredVisibilityConstraint.h.

Constructor & Destructor Documentation

vtkStructuredVisibilityConstraint::vtkStructuredVisibilityConstraint ( ) [protected]

vtkStructuredVisibilityConstraint::~vtkStructuredVisibilityConstraint ( ) [protected]

Member Function Documentation

vtkStructuredVisibilityConstraint* vtkStructuredVisibilityConstraint::New ( ) [static]

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

virtual const char* vtkStructuredVisibilityConstraint::GetClassName ( ) [virtual]

Reimplemented from vtkObject.

int vtkStructuredVisibilityConstraint::IsTypeOf ( const char * type ) [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 vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkObject.

virtual int vtkStructuredVisibilityConstraint::IsA ( const char * type ) [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 vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkObject.

vtkStructuredVisibilityConstraint* vtkStructuredVisibilityConstraint::SafeDownCast ( vtkObject * o ) [static]

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 113 of file vtkStructuredVisibilityConstraint.h.
References vtkUnsignedCharArray::GetValue(), and vtkIdType.

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 121 of file vtkStructuredVisibilityConstraint.h.
References vtkDataArray::Allocate(), vtkUnsignedCharArray::New(), vtkUnsignedCharArray::SetValue(), and vtkIdType.

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

Sets the visibility flag of the given point/cell on.
Definition at line 138 of file vtkStructuredVisibilityConstraint.h.
References vtkUnsignedCharArray::SetValue(), and vtkIdType.

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 149 of file vtkStructuredVisibilityConstraint.h.
References Dimensions, Initialized, and NumberOfIds.

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 visibile), 0 otherwise.
Definition at line 89 of file vtkStructuredVisibilityConstraint.h.

Member Data Documentation

vtkUnsignedCharArray* vtkStructuredVisibilityConstraint::VisibilityById [protected]

Definition at line 99 of file vtkStructuredVisibilityConstraint.h.

int vtkStructuredVisibilityConstraint::Dimensions[3] [protected]

Definition at line 100 of file vtkStructuredVisibilityConstraint.h.
Referenced by Initialize().

vtkIdType vtkStructuredVisibilityConstraint::NumberOfIds [protected]

Definition at line 101 of file vtkStructuredVisibilityConstraint.h.
Referenced by Initialize().

unsigned char vtkStructuredVisibilityConstraint::Initialized [protected]

Definition at line 102 of file vtkStructuredVisibilityConstraint.h.
Referenced by Initialize().

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

dox/Common/vtkStructuredVisibilityConstraint.h


Public Types
typedef vtkObject	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
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	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
vtkStructuredVisibilityConstraint *	New ()
int	IsTypeOf (const char *type)
vtkStructuredVisibilityConstraint *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkStructuredVisibilityConstraint ()
	~vtkStructuredVisibilityConstraint ()
Protected Attributes
vtkUnsignedCharArray *	VisibilityById
int	Dimensions [3]
vtkIdType	NumberOfIds
unsigned char	Initialized