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

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

#include <vtkStructuredVisibilityConstraint.h>

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

Public Types

typedef vtkObject Superclass
 
- Public Types inherited from vtkObject
typedef vtkObjectBase 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 vtkUnsignedCharArrayGetVisibilityById ()
 
unsigned char IsConstrained ()
 
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
 
virtual void DebugOff ()
 
unsigned char GetDebug ()
 
void SetDebug (unsigned char debugFlag)
 
virtual void Modified ()
 
virtual unsigned long GetMTime ()
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
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 *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
int HasObserver (unsigned long event)
 
int HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
int InvokeEvent (unsigned long event, void *callData)
 
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
 
virtual void Delete ()
 
virtual void FastDelete ()
 
void Print (ostream &os)
 
virtual void Register (vtkObjectBase *o)
 
virtual void UnRegister (vtkObjectBase *o)
 
void SetReferenceCount (int)
 
void PrintRevisions (ostream &os)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 

Static Public Member Functions

static
vtkStructuredVisibilityConstraint
New ()
 
static int IsTypeOf (const char *type)
 
static
vtkStructuredVisibilityConstraint
SafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkObject
static int IsTypeOf (const char *type)
 
static vtkObjectSafeDownCast (vtkObject *o)
 
static vtkObjectNew ()
 
static void BreakOnError ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static int IsTypeOf (const char *name)
 
static vtkObjectBaseNew ()
 

Protected Member Functions

 vtkStructuredVisibilityConstraint ()
 
 ~vtkStructuredVisibilityConstraint ()
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
virtual ~vtkObject ()
 
virtual void RegisterInternal (vtkObjectBase *, int check)
 
virtual void UnRegisterInternal (vtkObjectBase *, int check)
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &os)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkUnsignedCharArrayVisibilityById
 
int Dimensions [3]
 
vtkIdType NumberOfIds
 
unsigned char Initialized
 
- Protected Attributes inherited from vtkObject
unsigned char Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
int ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

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

Member Typedef Documentation

Definition at line 40 of file vtkStructuredVisibilityConstraint.h.

Constructor & Destructor Documentation

vtkStructuredVisibilityConstraint::vtkStructuredVisibilityConstraint ( )
protected
vtkStructuredVisibilityConstraint::~vtkStructuredVisibilityConstraint ( )
protected

Member Function Documentation

static vtkStructuredVisibilityConstraint* vtkStructuredVisibilityConstraint::New ( )
static
virtual const char* vtkStructuredVisibilityConstraint::GetClassName ( )
virtual

Reimplemented from vtkObject.

static int vtkStructuredVisibilityConstraint::IsTypeOf ( const char *  type)
static
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 ( vtkObject o)
static
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 103 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 111 of file vtkStructuredVisibilityConstraint.h.

void vtkStructuredVisibilityConstraint::UnBlank ( vtkIdType  id)
inline

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

Definition at line 128 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 139 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 79 of file vtkStructuredVisibilityConstraint.h.

Member Data Documentation

vtkUnsignedCharArray* vtkStructuredVisibilityConstraint::VisibilityById
protected

Definition at line 89 of file vtkStructuredVisibilityConstraint.h.

int vtkStructuredVisibilityConstraint::Dimensions[3]
protected

Definition at line 90 of file vtkStructuredVisibilityConstraint.h.

vtkIdType vtkStructuredVisibilityConstraint::NumberOfIds
protected

Definition at line 91 of file vtkStructuredVisibilityConstraint.h.

unsigned char vtkStructuredVisibilityConstraint::Initialized
protected

Definition at line 92 of file vtkStructuredVisibilityConstraint.h.


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