places vertices on circles in 3D More...

#include <vtkSimple3DCirclesStrategy.h>

Inheritance diagram for vtkSimple3DCirclesStrategy:

Collaboration diagram for vtkSimple3DCirclesStrategy:

Public Types
enum	{ FixedRadiusMethod = 0 , FixedDistanceMethod = 1 }

typedef vtkGraphLayoutStrategy	Superclass

Public Types inherited from vtkGraphLayoutStrategy
typedef vtkObject	Superclass

Public Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkSimple3DCirclesStrategy *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

void	Layout () override
	Standard layout method.

void	SetGraph (vtkGraph *graph) override
	Set graph (warning: HierarchicalOrder and HierarchicalLayers will set to zero.


virtual void	SetMethod (int)
	Set or get circle generating method (FixedRadiusMethod/FixedDistanceMethod).

virtual int	GetMethod ()
	Set or get circle generating method (FixedRadiusMethod/FixedDistanceMethod).


virtual void	SetRadius (double)
	If Method is FixedRadiusMethod: Set or get the radius of the circles.

virtual double	GetRadius ()
	If Method is FixedRadiusMethod: Set or get the radius of the circles.


virtual void	SetHeight (double)
	Set or get the vertical (local z) distance between the circles.

virtual double	GetHeight ()
	Set or get the vertical (local z) distance between the circles.


virtual void	SetOrigin (double, double, double)
	Set or get the origin of the geometry.

virtual void	SetOrigin (double[3])
	Set or get the origin of the geometry.

virtual double *	GetOrigin ()
	Set or get the origin of the geometry.

virtual void	GetOrigin (double &, double &, double &)
	Set or get the origin of the geometry.

virtual void	GetOrigin (double[3])
	Set or get the origin of the geometry.


virtual void	SetDirection (double dx, double dy, double dz)
	Set or get the normal vector of the circles plain.

virtual void	SetDirection (double d[3])
	Set or get the normal vector of the circles plain.

virtual double *	GetDirection ()
	Set or get the normal vector of the circles plain.

virtual void	GetDirection (double &, double &, double &)
	Set or get the normal vector of the circles plain.

virtual void	GetDirection (double[3])
	Set or get the normal vector of the circles plain.


virtual void	SetMarkedStartVertices (vtkAbstractArray *_arg)
	Set or get initial vertices.

virtual vtkAbstractArray *	GetMarkedStartVertices ()
	Set or get initial vertices.


virtual void	SetMarkedValue (vtkVariant _arg)
	Set or get MarkedValue.

virtual vtkVariant	GetMarkedValue ()
	Set or get MarkedValue.


virtual void	SetForceToUseUniversalStartPointsFinder (vtkTypeBool)
	Set or get ForceToUseUniversalStartPointsFinder.

virtual vtkTypeBool	GetForceToUseUniversalStartPointsFinder ()
	Set or get ForceToUseUniversalStartPointsFinder.

virtual void	ForceToUseUniversalStartPointsFinderOn ()
	Set or get ForceToUseUniversalStartPointsFinder.

virtual void	ForceToUseUniversalStartPointsFinderOff ()
	Set or get ForceToUseUniversalStartPointsFinder.


virtual void	SetAutoHeight (vtkTypeBool)
	Set or get auto height (Default: false).

virtual vtkTypeBool	GetAutoHeight ()
	Set or get auto height (Default: false).

virtual void	AutoHeightOn ()
	Set or get auto height (Default: false).

virtual void	AutoHeightOff ()
	Set or get auto height (Default: false).


virtual void	SetMinimumRadian (double)
	Set or get minimum radian (used by auto height).

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


virtual void	SetMinimumDegree (double degree)
	Set or get minimum degree (used by auto height).

virtual double	GetMinimumDegree ()
	Set or get minimum degree (used by auto height).


virtual void	SetHierarchicalLayers (vtkIntArray *_arg)
	Set or get hierarchical layers id by vertices (An usual vertex's layer id is greater or equal to zero.

virtual vtkIntArray *	GetHierarchicalLayers ()
	Set or get hierarchical layers id by vertices (An usual vertex's layer id is greater or equal to zero.


virtual void	SetHierarchicalOrder (vtkIdTypeArray *_arg)
	Set or get hierarchical ordering of vertices (The array starts from the first vertex's id.

virtual vtkIdTypeArray *	GetHierarchicalOrder ()
	Set or get hierarchical ordering of vertices (The array starts from the first vertex's id.

Public Member Functions inherited from vtkGraphLayoutStrategy
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkGraphLayoutStrategy *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

virtual void	SetGraph (vtkGraph *graph)
	Setting the graph for the layout strategy.

virtual void	Initialize ()
	This method allows the layout strategy to do initialization of data structures or whatever else it might want to do.

virtual void	Layout ()=0
	This is the layout method where the graph that was set in SetGraph() is laid out.

virtual int	IsLayoutComplete ()
	If your concrete class is iterative than you should overload IsLayoutComplete() otherwise it simply returns 1 by default;.

virtual void	SetWeightEdges (bool state)
	Whether to use edge weights in the layout or not.

virtual bool	GetWeightEdges ()
	Whether to use edge weights in the layout or not.

virtual void	SetEdgeWeightField (const char *field)
	Set/Get the field to use for the edge weights.

virtual char *	GetEdgeWeightField ()
	Set/Get the field to use for the edge weights.

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on.

virtual void	DebugOff ()
	Turn debugging output off.

bool	GetDebug ()
	Get the value of the debug flag.

void	SetDebug (bool debugFlag)
	Set the value of the debug flag.

virtual void	Modified ()
	Update the modification time for this object.

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

vtkTypeBool	HasObserver (unsigned long event)

vtkTypeBool	HasObserver (const char *event)

vtkTypeBool	InvokeEvent (unsigned long event)

vtkTypeBool	InvokeEvent (const char *event)

std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output.

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method.

vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.

vtkTypeBool	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not.

virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.

virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.

virtual std::string	GetObjectDescription () const
	The object description printed in messages and PrintSelf output.

virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.

virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

virtual void	Delete ()
	Delete a VTK object.

virtual void	FastDelete ()
	Delete a reference to this object.

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream.

void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).

int	GetReferenceCount ()
	Return the current reference count of this object.

void	SetReferenceCount (int)
	Sets the reference count.

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

virtual bool	UsesGarbageCollector () const
	Indicate whether the class uses `vtkGarbageCollector` or not.

Static Public Member Functions
static vtkSimple3DCirclesStrategy *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkSimple3DCirclesStrategy *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkGraphLayoutStrategy
static vtkTypeBool	IsTypeOf (const char *type)

static vtkGraphLayoutStrategy *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.

static void	SetGlobalWarningDisplay (vtkTypeBool val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static vtkTypeBool	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class.

static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.

static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkSimple3DCirclesStrategy ()

	~vtkSimple3DCirclesStrategy () override

void	Transform (double Local[], double Global[])

Protected Member Functions inherited from vtkGraphLayoutStrategy
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkGraphLayoutStrategy ()

	~vtkGraphLayoutStrategy () override

Protected Member Functions inherited from vtkObject
	vtkObject ()

	~vtkObject () override

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events.

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	ReportReferences (vtkGarbageCollector *)

virtual void	ObjectFinalize ()

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
double	Radius

double	Height

double	Origin [3]

double	Direction [3]

int	Method

vtkAbstractArray *	MarkedStartVertices

vtkVariant	MarkedValue

vtkTypeBool	ForceToUseUniversalStartPointsFinder

vtkTypeBool	AutoHeight

double	MinimumRadian

vtkIntArray *	HierarchicalLayers

vtkIdTypeArray *	HierarchicalOrder

Protected Attributes inherited from vtkGraphLayoutStrategy
vtkGraph *	Graph

char *	EdgeWeightField

bool	WeightEdges

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

std::string	ObjectName

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

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 between 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 separately. 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 47 of file vtkSimple3DCirclesStrategy.h.

Member Typedef Documentation

◆ Superclass

typedef vtkGraphLayoutStrategy vtkSimple3DCirclesStrategy::Superclass

Definition at line 51 of file vtkSimple3DCirclesStrategy.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerator
FixedRadiusMethod
FixedDistanceMethod

Definition at line 54 of file vtkSimple3DCirclesStrategy.h.

Constructor & Destructor Documentation

◆ vtkSimple3DCirclesStrategy()

vtkSimple3DCirclesStrategy::vtkSimple3DCirclesStrategy ( )

protected

◆ ~vtkSimple3DCirclesStrategy()

vtkSimple3DCirclesStrategy::~vtkSimple3DCirclesStrategy ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkSimple3DCirclesStrategy * vtkSimple3DCirclesStrategy::New ( )

static

◆ IsTypeOf()

static vtkTypeBool vtkSimple3DCirclesStrategy::IsTypeOf ( const char * type )

static

◆ IsA()

virtual vtkTypeBool 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.

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkSimple3DCirclesStrategy::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkGraphLayoutStrategy.

◆ NewInstance()

vtkSimple3DCirclesStrategy * vtkSimple3DCirclesStrategy::NewInstance ( ) const

◆ PrintSelf()

void vtkSimple3DCirclesStrategy::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

overridevirtual

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.

◆ SetMethod()

virtual void vtkSimple3DCirclesStrategy::SetMethod ( int )

virtual

Set or get circle generating method (FixedRadiusMethod/FixedDistanceMethod).

Default is FixedRadiusMethod.

◆ GetMethod()

virtual int vtkSimple3DCirclesStrategy::GetMethod ( )

virtual

Set or get circle generating method (FixedRadiusMethod/FixedDistanceMethod).

Default is FixedRadiusMethod.

◆ SetRadius()

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.

◆ GetRadius()

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.

◆ SetHeight()

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

◆ GetHeight()

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