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

places vertices on circles in 3D More...

#include <vtkSimple3DCirclesStrategy.h>

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

Public Types

enum  { FixedRadiusMethod = 0, FixedDistanceMethod = 1 }
 
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)
 
vtkSimple3DCirclesStrategyNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void Layout (void)
 
virtual void SetMethod (int)
 
virtual int GetMethod ()
 
virtual void SetRadius (double)
 
virtual double GetRadius ()
 
virtual void SetHeight (double)
 
virtual double GetHeight ()
 
virtual void SetOrigin (double, double, double)
 
virtual void SetOrigin (double[3])
 
virtual doubleGetOrigin ()
 
virtual void GetOrigin (double &, double &, double &)
 
virtual void GetOrigin (double[3])
 
virtual void SetDirection (double dx, double dy, double dz)
 
virtual void SetDirection (double d[3])
 
virtual doubleGetDirection ()
 
virtual void GetDirection (double &, double &, double &)
 
virtual void GetDirection (double[3])
 
virtual void SetMarkedStartVertices (vtkAbstractArray *_arg)
 
virtual vtkAbstractArrayGetMarkedStartVertices ()
 
virtual void SetMarkedValue (vtkVariant _arg)
 
virtual vtkVariant GetMarkedValue (void)
 
virtual void SetForceToUseUniversalStartPointsFinder (int)
 
virtual int GetForceToUseUniversalStartPointsFinder ()
 
virtual void ForceToUseUniversalStartPointsFinderOn ()
 
virtual void ForceToUseUniversalStartPointsFinderOff ()
 
virtual void SetAutoHeight (int)
 
virtual int GetAutoHeight ()
 
virtual void AutoHeightOn ()
 
virtual void AutoHeightOff ()
 
virtual void SetMinimumRadian (double)
 
virtual double GetMinimumRadian ()
 
virtual void SetMinimumDegree (double degree)
 
virtual double GetMinimumDegree (void)
 
virtual void SetHierarchicalLayers (vtkIntArray *_arg)
 
virtual vtkIntArrayGetHierarchicalLayers ()
 
virtual void SetHierarchicalOrder (vtkIdTypeArray *_arg)
 
virtual vtkIdTypeArrayGetHierarchicalOrder ()
 
- Public Member Functions inherited from vtkGraphLayoutStrategy
vtkGraphLayoutStrategyNewInstance () const
 
virtual void Initialize ()
 
virtual int IsLayoutComplete ()
 
virtual void SetWeightEdges (bool state)
 
virtual bool GetWeightEdges ()
 
virtual void SetEdgeWeightField (const char *field)
 
virtual char * GetEdgeWeightField ()
 
- Public Member Functions inherited from vtkObject
vtkObjectNewInstance () 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)
 
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)
 
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 vtkSimple3DCirclesStrategyNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSimple3DCirclesStrategySafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkGraphLayoutStrategy
static int IsTypeOf (const char *type)
 
static vtkGraphLayoutStrategySafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static int IsTypeOf (const char *type)
 
static vtkObjectSafeDownCast (vtkObjectBase *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

virtual vtkObjectBaseNewInstanceInternal () const
 
void Transform (double Local[], double Global[])
 
- 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 &)
 

Protected Attributes

double Radius
 
double Height
 
double Origin [3]
 
double Direction [3]
 
int Method
 
vtkAbstractArrayMarkedStartVertices
 
vtkVariant MarkedValue
 
int ForceToUseUniversalStartPointsFinder
 
int AutoHeight
 
double MinimumRadian
 
vtkIntArrayHierarchicalLayers
 
vtkIdTypeArrayHierarchicalOrder
 
- Protected Attributes inherited from vtkGraphLayoutStrategy
vtkGraphGraph
 
char * EdgeWeightField
 
bool WeightEdges
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 
virtual void SetGraph (vtkGraph *graph)
 
 vtkSimple3DCirclesStrategy (void)
 
virtual ~vtkSimple3DCirclesStrategy (void)
 

Detailed Description

places vertices on circles in 3D

Places vertices on circles depending on the graph vertices hierarchy level. The source graph could be vtkDirectedAcyclicGraph or vtkDirectedGraph if MarkedStartPoints array was added. The algorithm collects the standalone points, too and take them to a separated circle. If method is FixedRadiusMethod, the radius of the circles will be equal. If method is FixedDistanceMethod, the distance beetwen the points on circles will be equal.

In first step initial points are searched. A point is initial, if its in degree equal zero and out degree is greater than zero (or marked by MarkedStartVertices and out degree is greater than zero). Independent vertices (in and out degree equal zero) are collected separatelly. In second step the hierarchical level is generated for every vertex. In third step the hierarchical order is generated. If a vertex has no hierarchical level and it is not independent, the graph has loop so the algorithm exit with error message. Finally the vertices positions are calculated by the hierarchical order and by the vertices hierarchy levels.

Thanks:
Ferenc Nasztanovics, naszt.nosp@m.a@na.nosp@m.szta..nosp@m.hu, Budapest University of Technology and Economics, Department of Structural Mechanics
References:
in 3D rotation was used: http://en.citizendium.org/wiki/Rotation_matrix
Tests:
vtkSimple3DCirclesStrategy (Tests)

Definition at line 54 of file vtkSimple3DCirclesStrategy.h.

Member Typedef Documentation

Definition at line 58 of file vtkSimple3DCirclesStrategy.h.

Member Enumeration Documentation

anonymous enum
Enumerator
FixedRadiusMethod 
FixedDistanceMethod 

Definition at line 62 of file vtkSimple3DCirclesStrategy.h.

Constructor & Destructor Documentation

vtkSimple3DCirclesStrategy::vtkSimple3DCirclesStrategy ( void  )
protected

Set graph (warning: HierarchicalOrder and HierarchicalLayers will set to zero. These reference counts will be decreased!)

virtual vtkSimple3DCirclesStrategy::~vtkSimple3DCirclesStrategy ( void  )
protectedvirtual

Set graph (warning: HierarchicalOrder and HierarchicalLayers will set to zero. These reference counts will be decreased!)

Member Function Documentation

static vtkSimple3DCirclesStrategy* vtkSimple3DCirclesStrategy::New ( )
static
static int vtkSimple3DCirclesStrategy::IsTypeOf ( const char *  type)
static
virtual int vtkSimple3DCirclesStrategy::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 vtkSimple3DCirclesStrategy* vtkSimple3DCirclesStrategy::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkSimple3DCirclesStrategy::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkGraphLayoutStrategy.

vtkSimple3DCirclesStrategy* vtkSimple3DCirclesStrategy::NewInstance ( ) const
void vtkSimple3DCirclesStrategy::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 vtkSimple3DCirclesStrategy::SetMethod ( int  )
virtual

Set or get cicrle generating method (FixedRadiusMethod/FixedDistanceMethod). Default is FixedRadiusMethod.

virtual int vtkSimple3DCirclesStrategy::GetMethod ( )
virtual

Set or get cicrle generating method (FixedRadiusMethod/FixedDistanceMethod). Default is FixedRadiusMethod.

virtual void vtkSimple3DCirclesStrategy::SetRadius ( double  )
virtual

If Method is FixedRadiusMethod: Set or get the radius of the circles. If Method is FixedDistanceMethod: Set or get the distance of the points in the circle.

virtual double vtkSimple3DCirclesStrategy::GetRadius ( )
virtual

If Method is FixedRadiusMethod: Set or get the radius of the circles. If Method is FixedDistanceMethod: Set or get the distance of the points in the circle.

virtual void vtkSimple3DCirclesStrategy::SetHeight ( double  )
virtual

Set or get the vertical (local z) distance between the circles. If AutoHeight is on, this is the minimal height between the circle layers

virtual double vtkSimple3DCirclesStrategy::GetHeight ( )
virtual

Set or get the vertical (local z) distance between the circles. If AutoHeight is on, this is the minimal height between the circle layers

virtual void vtkSimple3DCirclesStrategy::SetOrigin ( double  ,
double  ,
double   
)
virtual

Set or get the origin of the geometry. This is the center of the first circle. SetOrigin(x,y,z)

virtual void vtkSimple3DCirclesStrategy::SetOrigin ( double  [3])
virtual

Set or get the origin of the geometry. This is the center of the first circle. SetOrigin(x,y,z)

virtual double* vtkSimple3DCirclesStrategy::GetOrigin ( )
virtual

Set or get the origin of the geometry. This is the center of the first circle. SetOrigin(x,y,z)

virtual void vtkSimple3DCirclesStrategy::GetOrigin ( double ,
double ,
double  
)
virtual

Set or get the origin of the geometry. This is the center of the first circle. SetOrigin(x,y,z)

virtual void vtkSimple3DCirclesStrategy::GetOrigin ( double  [3])
virtual

Set or get the origin of the geometry. This is the center of the first circle. SetOrigin(x,y,z)

virtual void vtkSimple3DCirclesStrategy::SetDirection ( double  dx,
double  dy,
double  dz 
)
virtual

Set or get the normal vector of the circles plain. The height is growing in this direction. The direction must not be zero vector. The default vector is (0.0,0.0,1.0)

virtual void vtkSimple3DCirclesStrategy::SetDirection ( double  d[3])
virtual

Set or get the normal vector of the circles plain. The height is growing in this direction. The direction must not be zero vector. The default vector is (0.0,0.0,1.0)

virtual double* vtkSimple3DCirclesStrategy::GetDirection ( )
virtual

Set or get the normal vector of the circles plain. The height is growing in this direction. The direction must not be zero vector. The default vector is (0.0,0.0,1.0)

virtual void vtkSimple3DCirclesStrategy::GetDirection ( double ,
double ,
double  
)
virtual

Set or get the normal vector of the circles plain. The height is growing in this direction. The direction must not be zero vector. The default vector is (0.0,0.0,1.0)

virtual void vtkSimple3DCirclesStrategy::GetDirection ( double  [3])
virtual

Set or get the normal vector of the circles plain. The height is growing in this direction. The direction must not be zero vector. The default vector is (0.0,0.0,1.0)

virtual void vtkSimple3DCirclesStrategy::SetMarkedStartVertices ( vtkAbstractArray _arg)
virtual

Set or get initial vertices. If MarkedStartVertices is added, loop is accepted in the graph. (If all of the loop start vertices are marked in MarkedStartVertices array.) MarkedStartVertices size must be equal with the number of the vertices in the graph. Start vertices must be marked by MarkedValue. (E.g.: if MarkedValue=3 and MarkedStartPoints is { 0, 3, 5, 3 }, the start points ids will be {1,3}.) )

virtual vtkAbstractArray* vtkSimple3DCirclesStrategy::GetMarkedStartVertices ( )
virtual

Set or get initial vertices. If MarkedStartVertices is added, loop is accepted in the graph. (If all of the loop start vertices are marked in MarkedStartVertices array.) MarkedStartVertices size must be equal with the number of the vertices in the graph. Start vertices must be marked by MarkedValue. (E.g.: if MarkedValue=3 and MarkedStartPoints is { 0, 3, 5, 3 }, the start points ids will be {1,3}.) )

virtual void vtkSimple3DCirclesStrategy::SetMarkedValue ( vtkVariant  _arg)
virtual

Set or get MarkedValue. See: MarkedStartVertices.

virtual vtkVariant vtkSimple3DCirclesStrategy::GetMarkedValue ( void  )
virtual

Set or get MarkedValue. See: MarkedStartVertices.

virtual void vtkSimple3DCirclesStrategy::SetForceToUseUniversalStartPointsFinder ( int  )
virtual

Set or get ForceToUseUniversalStartPointsFinder. If ForceToUseUniversalStartPointsFinder is true, MarkedStartVertices won't be used. In this case the input graph must be vtkDirectedAcyclicGraph (Defualt: false).

virtual int vtkSimple3DCirclesStrategy::GetForceToUseUniversalStartPointsFinder ( )
virtual

Set or get ForceToUseUniversalStartPointsFinder. If ForceToUseUniversalStartPointsFinder is true, MarkedStartVertices won't be used. In this case the input graph must be vtkDirectedAcyclicGraph (Defualt: false).

virtual void vtkSimple3DCirclesStrategy::ForceToUseUniversalStartPointsFinderOn ( )
virtual

Set or get ForceToUseUniversalStartPointsFinder. If ForceToUseUniversalStartPointsFinder is true, MarkedStartVertices won't be used. In this case the input graph must be vtkDirectedAcyclicGraph (Defualt: false).

virtual void vtkSimple3DCirclesStrategy::ForceToUseUniversalStartPointsFinderOff ( )
virtual

Set or get ForceToUseUniversalStartPointsFinder. If ForceToUseUniversalStartPointsFinder is true, MarkedStartVertices won't be used. In this case the input graph must be vtkDirectedAcyclicGraph (Defualt: false).

virtual void vtkSimple3DCirclesStrategy::SetAutoHeight ( int  )
virtual

Set or get auto height (Default: false). If AutoHeight is true, (r(i+1) - r(i-1))/Height will be smaller than tan(MinimumRadian). If you want equal distances and parallel circles, you should turn off AutoHeight.

virtual int vtkSimple3DCirclesStrategy::GetAutoHeight ( )
virtual

Set or get auto height (Default: false). If AutoHeight is true, (r(i+1) - r(i-1))/Height will be smaller than tan(MinimumRadian). If you want equal distances and parallel circles, you should turn off AutoHeight.

virtual void vtkSimple3DCirclesStrategy::AutoHeightOn ( )
virtual

Set or get auto height (Default: false). If AutoHeight is true, (r(i+1) - r(i-1))/Height will be smaller than tan(MinimumRadian). If you want equal distances and parallel circles, you should turn off AutoHeight.

virtual void vtkSimple3DCirclesStrategy::AutoHeightOff ( )
virtual

Set or get auto height (Default: false). If AutoHeight is true, (r(i+1) - r(i-1))/Height will be smaller than tan(MinimumRadian). If you want equal distances and parallel circles, you should turn off AutoHeight.

virtual void vtkSimple3DCirclesStrategy::SetMinimumRadian ( double  )
virtual

Set or get minimum radian (used by auto height).

virtual double vtkSimple3DCirclesStrategy::GetMinimumRadian ( )
virtual

Set or get minimum radian (used by auto height).

virtual void vtkSimple3DCirclesStrategy::SetMinimumDegree ( double  degree)
virtual

Set or get minimum degree (used by auto height). There is no separated minimum degree, so minimum radian will be changed.

virtual double vtkSimple3DCirclesStrategy::GetMinimumDegree ( void  )
virtual

Set or get minimum degree (used by auto height). There is no separated minimum degree, so minimum radian will be changed.

virtual void vtkSimple3DCirclesStrategy::SetHierarchicalLayers ( vtkIntArray _arg)
virtual

Set or get hierarchical layers id by vertices (An usual vertex's layer id is greater or equal to zero. If a vertex is standalone, its layer id is -2.) If no HierarchicalLayers array is defined, vtkSimple3DCirclesStrategy will generate it automatically (default).

virtual vtkIntArray* vtkSimple3DCirclesStrategy::GetHierarchicalLayers ( )
virtual

Set or get hierarchical layers id by vertices (An usual vertex's layer id is greater or equal to zero. If a vertex is standalone, its layer id is -2.) If no HierarchicalLayers array is defined, vtkSimple3DCirclesStrategy will generate it automatically (default).

virtual void vtkSimple3DCirclesStrategy::SetHierarchicalOrder ( vtkIdTypeArray _arg)
virtual

Set or get hierarchical ordering of vertices (The array starts from the first vertex's id. All id must be greater or equal to zero!) If no HierarchicalOrder is defined, vtkSimple3DCirclesStrategy will generate it automatically (default).

virtual vtkIdTypeArray* vtkSimple3DCirclesStrategy::GetHierarchicalOrder ( )
virtual

Set or get hierarchical ordering of vertices (The array starts from the first vertex's id. All id must be greater or equal to zero!) If no HierarchicalOrder is defined, vtkSimple3DCirclesStrategy will generate it automatically (default).

virtual void vtkSimple3DCirclesStrategy::Layout ( void  )
virtual

Standard layout method

Implements vtkGraphLayoutStrategy.

virtual void vtkSimple3DCirclesStrategy::SetGraph ( vtkGraph graph)
virtual

Set graph (warning: HierarchicalOrder and HierarchicalLayers will set to zero. These reference counts will be decreased!)

Reimplemented from vtkGraphLayoutStrategy.

void vtkSimple3DCirclesStrategy::Transform ( double  Local[],
double  Global[] 
)
inlineprotected

Member Data Documentation

double vtkSimple3DCirclesStrategy::Radius
protected

Definition at line 176 of file vtkSimple3DCirclesStrategy.h.

double vtkSimple3DCirclesStrategy::Height
protected

Definition at line 177 of file vtkSimple3DCirclesStrategy.h.

double vtkSimple3DCirclesStrategy::Origin[3]
protected

Definition at line 178 of file vtkSimple3DCirclesStrategy.h.

double vtkSimple3DCirclesStrategy::Direction[3]
protected

Definition at line 179 of file vtkSimple3DCirclesStrategy.h.

int vtkSimple3DCirclesStrategy::Method
protected

Definition at line 180 of file vtkSimple3DCirclesStrategy.h.

vtkAbstractArray* vtkSimple3DCirclesStrategy::MarkedStartVertices
protected

Definition at line 181 of file vtkSimple3DCirclesStrategy.h.

vtkVariant vtkSimple3DCirclesStrategy::MarkedValue
protected

Definition at line 182 of file vtkSimple3DCirclesStrategy.h.

int vtkSimple3DCirclesStrategy::ForceToUseUniversalStartPointsFinder
protected

Definition at line 183 of file vtkSimple3DCirclesStrategy.h.

int vtkSimple3DCirclesStrategy::AutoHeight
protected

Definition at line 184 of file vtkSimple3DCirclesStrategy.h.

double vtkSimple3DCirclesStrategy::MinimumRadian
protected

Definition at line 185 of file vtkSimple3DCirclesStrategy.h.

vtkIntArray* vtkSimple3DCirclesStrategy::HierarchicalLayers
protected

Definition at line 187 of file vtkSimple3DCirclesStrategy.h.

vtkIdTypeArray* vtkSimple3DCirclesStrategy::HierarchicalOrder
protected

Definition at line 188 of file vtkSimple3DCirclesStrategy.h.


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