VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions
vtkPassThroughLayoutStrategy Class Reference

a layout strategy that does absolutely nothing More...

#include <vtkPassThroughLayoutStrategy.h>

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

List of all members.

Public Types

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

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual void Initialize ()
virtual void Layout ()
virtual int IsLayoutComplete ()
- Public Member Functions inherited from vtkGraphLayoutStrategy
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
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
vtkPassThroughLayoutStrategy
New ()
static int IsTypeOf (const char *type)
static
vtkPassThroughLayoutStrategy
SafeDownCast (vtkObject *o)

Protected Member Functions

 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 &os)
virtual void ReportReferences (vtkGarbageCollector *)
 vtkObjectBase (const vtkObjectBase &)
void operator= (const vtkObjectBase &)

Additional Inherited Members

- Protected Attributes inherited from vtkGraphLayoutStrategy
vtkGraphGraph
char * EdgeWeightField
bool WeightEdges
- Protected Attributes inherited from vtkObject
unsigned char Debug
vtkTimeStamp MTime
vtkSubjectHelper * SubjectHelper
- Protected Attributes inherited from vtkObjectBase
int 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 37 of file vtkPassThroughLayoutStrategy.h.


Member Typedef Documentation

Reimplemented from vtkGraphLayoutStrategy.

Definition at line 42 of file vtkPassThroughLayoutStrategy.h.


Constructor & Destructor Documentation

vtkPassThroughLayoutStrategy::vtkPassThroughLayoutStrategy ( )
protected
vtkPassThroughLayoutStrategy::~vtkPassThroughLayoutStrategy ( )
protected

Member Function Documentation

static vtkPassThroughLayoutStrategy* vtkPassThroughLayoutStrategy::New ( )
static

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

Reimplemented from vtkObject.

virtual const char* vtkPassThroughLayoutStrategy::GetClassName ( )
virtual

Reimplemented from vtkGraphLayoutStrategy.

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

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 ( vtkObject o)
static

Reimplemented from vtkGraphLayoutStrategy.

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 58 of file vtkPassThroughLayoutStrategy.h.


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