randomly places vertices in 2 or 3 dimensions More...

#include <vtkRandomLayoutStrategy.h>

Inheritance diagram for vtkRandomLayoutStrategy:

Collaboration diagram for vtkRandomLayoutStrategy:

Public Types
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. More...

vtkRandomLayoutStrategy *	NewInstance () const

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

void	SetGraph (vtkGraph *graph) override
	Set the graph to layout. More...

void	Layout () override
	Perform the random layout. More...


virtual void	SetRandomSeed (int)
	Seed the random number generator used to compute point positions. More...

virtual int	GetRandomSeed ()
	Seed the random number generator used to compute point positions. More...


virtual void	SetGraphBounds (double, double, double, double, double, double)
	Set / get the region in space in which to place the final graph. More...

virtual void	SetGraphBounds (double[6])
	Set / get the region in space in which to place the final graph. More...

virtual double *	GetGraphBounds ()
	Set / get the region in space in which to place the final graph. More...

virtual void	GetGraphBounds (double data[6])
	Set / get the region in space in which to place the final graph. More...


virtual void	SetAutomaticBoundsComputation (vtkTypeBool)
	Turn on/off automatic graph bounds calculation. More...

virtual vtkTypeBool	GetAutomaticBoundsComputation ()
	Turn on/off automatic graph bounds calculation. More...

virtual void	AutomaticBoundsComputationOn ()
	Turn on/off automatic graph bounds calculation. More...

virtual void	AutomaticBoundsComputationOff ()
	Turn on/off automatic graph bounds calculation. More...


virtual void	SetThreeDimensionalLayout (vtkTypeBool)
	Turn on/off layout of graph in three dimensions. More...

virtual vtkTypeBool	GetThreeDimensionalLayout ()
	Turn on/off layout of graph in three dimensions. More...

virtual void	ThreeDimensionalLayoutOn ()
	Turn on/off layout of graph in three dimensions. More...

virtual void	ThreeDimensionalLayoutOff ()
	Turn on/off layout of graph in three dimensions. More...

Public Member Functions inherited from vtkGraphLayoutStrategy
vtkGraphLayoutStrategy *	NewInstance () const

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

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

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

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

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

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

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

virtual void	DebugOn ()
	Turn debugging output on. More...

virtual void	DebugOff ()
	Turn debugging output off. More...

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

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

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

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

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. More...

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

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

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

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

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

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

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

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

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. More...

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. More...

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. More...

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

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

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

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

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

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). More...

virtual void	Delete ()
	Delete a VTK object. More...

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

void	InitializeObjectBase ()

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

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

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

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

void	SetReferenceCount (int)
	Sets the reference count. More...

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

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

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

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

Static Public Member Functions
static vtkRandomLayoutStrategy *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkRandomLayoutStrategy *	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. More...

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

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

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

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

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

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. More...

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). More...

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

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

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. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkRandomLayoutStrategy ()

	~vtkRandomLayoutStrategy () override

Protected Member Functions inherited from vtkGraphLayoutStrategy
	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. More...

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

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
int	RandomSeed

double	GraphBounds [6]

vtkTypeBool	AutomaticBoundsComputation

vtkTypeBool	ThreeDimensionalLayout

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

randomly places vertices in 2 or 3 dimensions

Assigns points to the vertices of a graph randomly within a bounded range.

.SECTION Thanks Thanks to Brian Wylie from Sandia National Laboratories for adding incremental layout capabilities.

Tests:: vtkRandomLayoutStrategy (Tests)

Definition at line 26 of file vtkRandomLayoutStrategy.h.

Member Typedef Documentation

◆ Superclass

typedef vtkGraphLayoutStrategy vtkRandomLayoutStrategy::Superclass

Definition at line 31 of file vtkRandomLayoutStrategy.h.

Constructor & Destructor Documentation

◆ vtkRandomLayoutStrategy()

vtkRandomLayoutStrategy::vtkRandomLayoutStrategy ( )

protected

◆ ~vtkRandomLayoutStrategy()

vtkRandomLayoutStrategy::~vtkRandomLayoutStrategy ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkRandomLayoutStrategy* vtkRandomLayoutStrategy::New ( )

static

◆ IsTypeOf()

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

static

◆ IsA()

virtual vtkTypeBool vtkRandomLayoutStrategy::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 vtkRandomLayoutStrategy* vtkRandomLayoutStrategy::SafeDownCast ( vtkObjectBase * o )

static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkRandomLayoutStrategy::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkGraphLayoutStrategy.

◆ NewInstance()

vtkRandomLayoutStrategy* vtkRandomLayoutStrategy::NewInstance ( ) const

◆ PrintSelf()

void vtkRandomLayoutStrategy::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.

◆ SetRandomSeed()

virtual void vtkRandomLayoutStrategy::SetRandomSeed ( int )

virtual

Seed the random number generator used to compute point positions.

This has a significant effect on their final positions when the layout is complete.

◆ GetRandomSeed()

virtual int vtkRandomLayoutStrategy::GetRandomSeed ( )

virtual

Seed the random number generator used to compute point positions.

This has a significant effect on their final positions when the layout is complete.

◆ SetGraphBounds() [1/2]

virtual void vtkRandomLayoutStrategy::SetGraphBounds	(	double	,
		double	,
		double	,
		double	,
		double	,
		double
	)

virtual

Set / get the region in space in which to place the final graph.

The GraphBounds only affects the results if AutomaticBoundsComputation is off.

◆ SetGraphBounds() [2/2]

virtual void vtkRandomLayoutStrategy::SetGraphBounds ( double [6] )

virtual

Set / get the region in space in which to place the final graph.

The GraphBounds only affects the results if AutomaticBoundsComputation is off.

◆ GetGraphBounds() [1/2]

virtual double* vtkRandomLayoutStrategy::GetGraphBounds ( )

virtual

Set / get the region in space in which to place the final graph.

The GraphBounds only affects the results if AutomaticBoundsComputation is off.

◆ GetGraphBounds() [2/2]

virtual void vtkRandomLayoutStrategy::GetGraphBounds ( double data[6] )

virtual

Set / get the region in space in which to place the final graph.

The GraphBounds only affects the results if AutomaticBoundsComputation is off.

◆ SetAutomaticBoundsComputation()

virtual void vtkRandomLayoutStrategy::SetAutomaticBoundsComputation ( vtkTypeBool )

virtual

Turn on/off automatic graph bounds calculation.

If this boolean is off, then the manually specified GraphBounds is used. If on, then the input's bounds us used as the graph bounds.

◆ GetAutomaticBoundsComputation()

virtual vtkTypeBool vtkRandomLayoutStrategy::GetAutomaticBoundsComputation ( )

virtual

Turn on/off automatic graph bounds calculation.

If this boolean is off, then the manually specified GraphBounds is used. If on, then the input's bounds us used as the graph bounds.

◆ AutomaticBoundsComputationOn()

virtual void vtkRandomLayoutStrategy::AutomaticBoundsComputationOn ( )

virtual

Turn on/off automatic graph bounds calculation.

If this boolean is off, then the manually specified GraphBounds is used. If on, then the input's bounds us used as the graph bounds.

◆ AutomaticBoundsComputationOff()

virtual void vtkRandomLayoutStrategy::AutomaticBoundsComputationOff ( )

virtual

Turn on/off automatic graph bounds calculation.

If this boolean is off, then the manually specified GraphBounds is used. If on, then the input's bounds us used as the graph bounds.

◆ SetThreeDimensionalLayout()

virtual void vtkRandomLayoutStrategy::SetThreeDimensionalLayout ( vtkTypeBool )

virtual

Turn on/off layout of graph in three dimensions.

If off, graph layout occurs in two dimensions. By default, three dimensional layout is on.

◆ GetThreeDimensionalLayout()

virtual vtkTypeBool vtkRandomLayoutStrategy::GetThreeDimensionalLayout ( )

virtual

Turn on/off layout of graph in three dimensions.

If off, graph layout occurs in two dimensions. By default, three dimensional layout is on.

◆ ThreeDimensionalLayoutOn()

virtual void vtkRandomLayoutStrategy::ThreeDimensionalLayoutOn ( )

virtual

Turn on/off layout of graph in three dimensions.

If off, graph layout occurs in two dimensions. By default, three dimensional layout is on.

◆ ThreeDimensionalLayoutOff()

virtual void vtkRandomLayoutStrategy::ThreeDimensionalLayoutOff ( )

virtual

Turn on/off layout of graph in three dimensions.

If off, graph layout occurs in two dimensions. By default, three dimensional layout is on.

◆ SetGraph()

void vtkRandomLayoutStrategy::SetGraph ( vtkGraph * graph )

overridevirtual

Set the graph to layout.

Reimplemented from vtkGraphLayoutStrategy.

◆ Layout()

void vtkRandomLayoutStrategy::Layout ( )

overridevirtual

Perform the random layout.

Implements vtkGraphLayoutStrategy.

Member Data Documentation

◆ RandomSeed

int vtkRandomLayoutStrategy::RandomSeed

protected

Definition at line 90 of file vtkRandomLayoutStrategy.h.

◆ GraphBounds

double vtkRandomLayoutStrategy::GraphBounds[6]

protected

Definition at line 91 of file vtkRandomLayoutStrategy.h.

◆ AutomaticBoundsComputation

vtkTypeBool vtkRandomLayoutStrategy::AutomaticBoundsComputation

protected

Definition at line 92 of file vtkRandomLayoutStrategy.h.

◆ ThreeDimensionalLayout

vtkTypeBool vtkRandomLayoutStrategy::ThreeDimensionalLayout

protected

Definition at line 93 of file vtkRandomLayoutStrategy.h.

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

Infovis/Layout/vtkRandomLayoutStrategy.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkRandomLayoutStrategy()

◆ ~vtkRandomLayoutStrategy()

Member Function Documentation

◆ New()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ SetRandomSeed()

◆ GetRandomSeed()

◆ SetGraphBounds() [1/2]

◆ SetGraphBounds() [2/2]

◆ GetGraphBounds() [1/2]

◆ GetGraphBounds() [2/2]

◆ SetAutomaticBoundsComputation()

◆ GetAutomaticBoundsComputation()

◆ AutomaticBoundsComputationOn()

◆ AutomaticBoundsComputationOff()

◆ SetThreeDimensionalLayout()

◆ GetThreeDimensionalLayout()

◆ ThreeDimensionalLayoutOn()

◆ ThreeDimensionalLayoutOff()

◆ SetGraph()

◆ Layout()

Member Data Documentation

◆ RandomSeed

◆ GraphBounds

◆ AutomaticBoundsComputation

◆ ThreeDimensionalLayout