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

Representation of a single graph edge. More...

#include <vtkGraphEdge.h>

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

Public Types

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...
 
vtkGraphEdgeNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void SetSource (vtkIdType)
 The source of the edge. More...
 
virtual vtkIdType GetSource ()
 
virtual void SetTarget (vtkIdType)
 The target of the edge. More...
 
virtual vtkIdType GetTarget ()
 
virtual void SetId (vtkIdType)
 The id of the edge. More...
 
virtual vtkIdType GetId ()
 
- 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 vtkGraphEdgeNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkGraphEdgeSafeDownCast (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
 
 vtkGraphEdge ()
 
 ~vtkGraphEdge () 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

vtkIdType Source
 
vtkIdType Target
 
vtkIdType Id
 
- 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

Representation of a single graph edge.

A heavy-weight (vtkObject subclass) graph edge object that may be used instead of the vtkEdgeType struct, for use with wrappers. The edge contains the source and target vertex ids, and the edge id.

See also
vtkGraph

Definition at line 39 of file vtkGraphEdge.h.

Member Typedef Documentation

◆ Superclass

Definition at line 43 of file vtkGraphEdge.h.

Constructor & Destructor Documentation

◆ vtkGraphEdge()

vtkGraphEdge::vtkGraphEdge ( )
protected

◆ ~vtkGraphEdge()

vtkGraphEdge::~vtkGraphEdge ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkGraphEdge* vtkGraphEdge::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkGraphEdge::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 vtkObjectBase.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkGraphEdge::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkGraphEdge* vtkGraphEdge::NewInstance ( ) const

◆ PrintSelf()

void vtkGraphEdge::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 vtkObject.

◆ SetSource()

virtual void vtkGraphEdge::SetSource ( vtkIdType  )
virtual

The source of the edge.

◆ GetSource()

virtual vtkIdType vtkGraphEdge::GetSource ( )
virtual

◆ SetTarget()

virtual void vtkGraphEdge::SetTarget ( vtkIdType  )
virtual

The target of the edge.

◆ GetTarget()

virtual vtkIdType vtkGraphEdge::GetTarget ( )
virtual

◆ SetId()

virtual void vtkGraphEdge::SetId ( vtkIdType  )
virtual

The id of the edge.

◆ GetId()

virtual vtkIdType vtkGraphEdge::GetId ( )
virtual

Member Data Documentation

◆ Source

vtkIdType vtkGraphEdge::Source
protected

Definition at line 74 of file vtkGraphEdge.h.

◆ Target

vtkIdType vtkGraphEdge::Target
protected

Definition at line 75 of file vtkGraphEdge.h.

◆ Id

vtkIdType vtkGraphEdge::Id
protected

Definition at line 76 of file vtkGraphEdge.h.


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