vtkPassThroughLayoutStrategy Class Reference

a layout strategy that does absolutely nothing More...

#include <vtkPassThroughLayoutStrategy.h>

Inheritance diagram for vtkPassThroughLayoutStrategy:

Collaboration diagram for vtkPassThroughLayoutStrategy:

Public Types
typedef vtkGraphLayoutStrategy	Superclass
Public Types inherited from vtkGraphLayoutStrategy
typedef vtkObject	Superclass
Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)
vtkPassThroughLayoutStrategy *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	Initialize ()
virtual void	Layout ()
virtual int	IsLayoutComplete ()
Public Member Functions inherited from vtkGraphLayoutStrategy
vtkGraphLayoutStrategy *	NewInstance () const
virtual void	SetGraph (vtkGraph *graph)
virtual void	SetWeightEdges (bool state)
virtual bool	GetWeightEdges ()
virtual void	SetEdgeWeightField (const char *field)
virtual char *	GetEdgeWeightField ()
Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const
virtual void	DebugOn ()
virtual void	DebugOff ()
bool	GetDebug ()
void	SetDebug (bool 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)
vtkCommand *	GetCommand (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)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(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 &)
virtual void	PrintHeader (ostream &os, vtkIndent indent)
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
int	GetReferenceCount ()

Static Public Member Functions
static vtkPassThroughLayoutStrategy *	New ()
static int	IsTypeOf (const char *type)
static vtkPassThroughLayoutStrategy *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkGraphLayoutStrategy
static int	IsTypeOf (const char *type)
static vtkGraphLayoutStrategy *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)
static vtkObject *	SafeDownCast (vtkObjectBase *o)
static vtkObject *	New ()
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 vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkPassThroughLayoutStrategy ()
	~vtkPassThroughLayoutStrategy ()
Protected Member Functions inherited from vtkGraphLayoutStrategy
	vtkGraphLayoutStrategy ()
	~vtkGraphLayoutStrategy ()
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 &)
virtual void	ReportReferences (vtkGarbageCollector *)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Additional Inherited Members
Protected Attributes inherited from vtkGraphLayoutStrategy
vtkGraph *	Graph
char *	EdgeWeightField
bool	WeightEdges
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Detailed Description

a layout strategy that does absolutely nothing

Yes, this incredible strategy does absoluted nothing to the data so in affect passes through the graph untouched. This strategy is useful in the cases where the graph is already laid out.

Tests:

vtkPassThroughLayoutStrategy (Tests)

Definition at line 38 of file vtkPassThroughLayoutStrategy.h.

Member Typedef Documentation

typedef vtkGraphLayoutStrategy vtkPassThroughLayoutStrategy::Superclass

Definition at line 43 of file vtkPassThroughLayoutStrategy.h.

Constructor & Destructor Documentation

vtkPassThroughLayoutStrategy::vtkPassThroughLayoutStrategy ( )

protected

vtkPassThroughLayoutStrategy::~vtkPassThroughLayoutStrategy ( )

protected

Member Function Documentation

static vtkPassThroughLayoutStrategy* vtkPassThroughLayoutStrategy::New ( )

static

static int vtkPassThroughLayoutStrategy::IsTypeOf ( const char *  type )

static

virtual int vtkPassThroughLayoutStrategy::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 vtkGraphLayoutStrategy.

static vtkPassThroughLayoutStrategy* vtkPassThroughLayoutStrategy::SafeDownCast ( vtkObjectBase *  o )

static

virtual vtkObjectBase* vtkPassThroughLayoutStrategy::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkGraphLayoutStrategy.

vtkPassThroughLayoutStrategy* vtkPassThroughLayoutStrategy::NewInstance

(

)

const

void vtkPassThroughLayoutStrategy::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 vtkGraphLayoutStrategy.

virtual void vtkPassThroughLayoutStrategy::Initialize ( )

virtual

This strategy sets up some data structures for faster processing of each Layout() call

Reimplemented from vtkGraphLayoutStrategy.

virtual void vtkPassThroughLayoutStrategy::Layout ( )

virtual

This is the layout method where the graph that was set in SetGraph() is laid out. The method can either entirely layout the graph or iteratively lay out the graph. If you have an iterative layout please implement the IsLayoutComplete() method.

Implements vtkGraphLayoutStrategy.

virtual int vtkPassThroughLayoutStrategy::IsLayoutComplete ( )

inlinevirtual

I'm an iterative layout so this method lets the caller know if I'm done laying out the graph

Reimplemented from vtkGraphLayoutStrategy.

Definition at line 59 of file vtkPassThroughLayoutStrategy.h.

---

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

• /home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Infovis/Layout/vtkPassThroughLayoutStrategy.h