VTK  9.3.20240329
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...
 
void Layout () override
 Perform the layout. More...
 
virtual void SetGlobeRadius (double)
 The base radius used to determine the earth's surface. More...
 
virtual double GetGlobeRadius ()
 The base radius used to determine the earth's surface. More...
 
virtual void SetExplodeFactor (double)
 Factor on which to "explode" the arcs away from the surface. More...
 
virtual double GetExplodeFactor ()
 Factor on which to "explode" the arcs away from the surface. More...
 
virtual void SetNumberOfSubdivisions (int)
 The number of subdivisions in the arc. More...
 
virtual int GetNumberOfSubdivisions ()
 The number of subdivisions in the arc. 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 ()
 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...
 
vtkCommandGetCommand (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 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 (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 vtkObjectBaseNew ()
 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 vtkObjectBaseNewInstanceInternal () const
 
 vtkGeoEdgeStrategy ()
 
 ~vtkGeoEdgeStrategy () override=default
 
- 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 ()
 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

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

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.

Events:
vtkCommand::ProgressEvent

Definition at line 24 of file vtkGeoEdgeStrategy.h.

Member Typedef Documentation

◆ Superclass

Definition at line 28 of file vtkGeoEdgeStrategy.h.

Constructor & Destructor Documentation

◆ vtkGeoEdgeStrategy()

vtkGeoEdgeStrategy::vtkGeoEdgeStrategy ( )
protected

◆ ~vtkGeoEdgeStrategy()

vtkGeoEdgeStrategy::~vtkGeoEdgeStrategy ( )
overrideprotecteddefault

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

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.

◆ 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

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.

◆ SetNumberOfSubdivisions()

virtual void vtkGeoEdgeStrategy::SetNumberOfSubdivisions ( int  )
virtual

The number of subdivisions in the arc.

The default is 20.

◆ GetNumberOfSubdivisions()

virtual int vtkGeoEdgeStrategy::GetNumberOfSubdivisions ( )
virtual

The number of subdivisions in the arc.

The default is 20.

◆ Layout()

void vtkGeoEdgeStrategy::Layout ( )
overridevirtual

Perform the layout.

Implements vtkEdgeLayoutStrategy.

Member Data Documentation

◆ GlobeRadius

double vtkGeoEdgeStrategy::GlobeRadius
protected

Definition at line 71 of file vtkGeoEdgeStrategy.h.

◆ ExplodeFactor

double vtkGeoEdgeStrategy::ExplodeFactor
protected

Definition at line 72 of file vtkGeoEdgeStrategy.h.

◆ NumberOfSubdivisions

int vtkGeoEdgeStrategy::NumberOfSubdivisions
protected

Definition at line 73 of file vtkGeoEdgeStrategy.h.


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