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

Layout graph edges on a globe as arcs. More...

#include <vtkGeoEdgeStrategy.h>

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

Public Types

typedef vtkEdgeLayoutStrategy Superclass
 
- Public Types inherited from vtkEdgeLayoutStrategy
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...
 
vtkGeoEdgeStrategyNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void SetGlobeRadius (double)
 The base radius used to determine the earth's surface. More...
 
virtual double GetGlobeRadius ()
 
virtual void SetExplodeFactor (double)
 Factor on which to "explode" the arcs away from the surface. More...
 
virtual double GetExplodeFactor ()
 
virtual void SetNumberOfSubdivisions (int)
 The number of subdivisions in the arc. More...
 
virtual int GetNumberOfSubdivisions ()
 
void Layout () override
 Perform the layout. More...
 
- Public Member Functions inherited from vtkEdgeLayoutStrategy
vtkEdgeLayoutStrategyNewInstance () const
 
virtual void SetGraph (vtkGraph *graph)
 Setting the graph for the layout strategy. More...
 
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 void SetEdgeWeightArrayName (const char *)
 Set/Get the field to use for the edge weights. More...
 
virtual char * GetEdgeWeightArrayName ()
 
- 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...
 
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)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
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)
 
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)
 
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...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
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
 Return the class name as a string. 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...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
virtual 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...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkGeoEdgeStrategyNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkGeoEdgeStrategySafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkEdgeLayoutStrategy
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkEdgeLayoutStrategySafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 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 (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- 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 vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkGeoEdgeStrategy ()
 
 ~vtkGeoEdgeStrategy () override
 
- Protected Member Functions inherited from vtkEdgeLayoutStrategy
 vtkEdgeLayoutStrategy ()
 
 ~vtkEdgeLayoutStrategy () 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 ()
 
- 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 GlobeRadius
 
double ExplodeFactor
 
int NumberOfSubdivisions
 
- Protected Attributes inherited from vtkEdgeLayoutStrategy
vtkGraphGraph
 
char * EdgeWeightArrayName
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

Layout graph edges on a globe as arcs.

vtkGeoEdgeStrategy produces arcs for each edge in the input graph. This is useful for viewing lines on a sphere (e.g. the earth). The arcs may "jump" above the sphere's surface using ExplodeFactor.

Definition at line 36 of file vtkGeoEdgeStrategy.h.

Member Typedef Documentation

◆ Superclass

Definition at line 40 of file vtkGeoEdgeStrategy.h.

Constructor & Destructor Documentation

◆ vtkGeoEdgeStrategy()

vtkGeoEdgeStrategy::vtkGeoEdgeStrategy ( )
protected

◆ ~vtkGeoEdgeStrategy()

vtkGeoEdgeStrategy::~vtkGeoEdgeStrategy ( )
inlineoverrideprotected

Definition at line 81 of file vtkGeoEdgeStrategy.h.

Member Function Documentation

◆ New()

static vtkGeoEdgeStrategy* vtkGeoEdgeStrategy::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkGeoEdgeStrategy::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 vtkEdgeLayoutStrategy.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkGeoEdgeStrategy::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkEdgeLayoutStrategy.

◆ NewInstance()

vtkGeoEdgeStrategy* vtkGeoEdgeStrategy::NewInstance ( ) const

◆ PrintSelf()

void vtkGeoEdgeStrategy::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 vtkEdgeLayoutStrategy.

◆ SetGlobeRadius()

virtual void vtkGeoEdgeStrategy::SetGlobeRadius ( double  )
virtual

The base radius used to determine the earth's surface.

Default is the earth's radius in meters. TODO: Change this to take in a vtkGeoTerrain to get altitude.

◆ GetGlobeRadius()

virtual double vtkGeoEdgeStrategy::GetGlobeRadius ( )
virtual

◆ SetExplodeFactor()

virtual void vtkGeoEdgeStrategy::SetExplodeFactor ( double  )
virtual

Factor on which to "explode" the arcs away from the surface.

A value of 0.0 keeps the values on the surface. Values larger than 0.0 push the arcs away from the surface by a distance proportional to the distance between the points. The default is 0.2.

◆ GetExplodeFactor()

virtual double vtkGeoEdgeStrategy::GetExplodeFactor ( )
virtual

◆ SetNumberOfSubdivisions()

virtual void vtkGeoEdgeStrategy::SetNumberOfSubdivisions ( int  )
virtual

The number of subdivisions in the arc.

The default is 20.

◆ GetNumberOfSubdivisions()

virtual int vtkGeoEdgeStrategy::GetNumberOfSubdivisions ( )
virtual

◆ Layout()

void vtkGeoEdgeStrategy::Layout ( )
overridevirtual

Perform the layout.

Implements vtkEdgeLayoutStrategy.

Member Data Documentation

◆ GlobeRadius

double vtkGeoEdgeStrategy::GlobeRadius
protected

Definition at line 83 of file vtkGeoEdgeStrategy.h.

◆ ExplodeFactor

double vtkGeoEdgeStrategy::ExplodeFactor
protected

Definition at line 84 of file vtkGeoEdgeStrategy.h.

◆ NumberOfSubdivisions

int vtkGeoEdgeStrategy::NumberOfSubdivisions
protected

Definition at line 85 of file vtkGeoEdgeStrategy.h.


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