ActiViz .NET  5.8.0
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Private Member Functions | Static Private Member Functions
Kitware.VTK.vtkEdgeTable Class Reference

vtkEdgeTable - keep track of edges (edge is pair of integer id's) More...

Inheritance diagram for Kitware.VTK.vtkEdgeTable:
[legend]
Collaboration diagram for Kitware.VTK.vtkEdgeTable:
[legend]

List of all members.

Public Member Functions

 vtkEdgeTable (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkEdgeTable ()
 Instantiate object assuming that 1000 edges are to be inserted.
int GetNextEdge (ref int p1, ref int p2)
 Traverse list of edges in table. Return the edge as (p1,p2), where p1 and p2 are point id's. Method return value is <0 if list is exhausted; non-zero otherwise. The value of p1 is guaranteed to be <= p2.
virtual int GetNumberOfEdges ()
 Return the number of edges that have been inserted thus far.
int InitEdgeInsertion (int numPoints, int storeAttributes)
 Initialize the edge insertion process. Provide an estimate of the number of points in a dataset (the maximum range value of p1 or p2). The storeAttributes variable controls whether attributes are to be stored with the edge, and what type of attributes. If storeAttributes==1, then attributes of vtkIdType can be stored. If storeAttributes==2, then attributes of type void* can be stored. In either case, additional memory will be required by the data structure to store attribute data per each edge. This method is used in conjunction with one of the three InsertEdge() methods described below (don't mix the InsertEdge() methods---make sure that the one used is consistent with the storeAttributes flag set in InitEdgeInsertion()).
int InitPointInsertion (vtkPoints newPts, int estSize)
 Initialize the point insertion process. The newPts is an object representing point coordinates into which incremental insertion methods place their data. The points are associated with the edge.
void InitTraversal ()
 Intialize traversal of edges in table.
void Initialize ()
 Free memory and return to the initially instantiated state.
int InsertEdge (int p1, int p2)
 Insert the edge (p1,p2) into the table. It is the user's responsibility to check if the edge has already been inserted (use IsEdge()). If the storeAttributes flag in InitEdgeInsertion() has been set, then the method returns a unique integer id (i.e., the edge id) that can be used to set and get edge attributes. Otherwise, the method will return 1. Do not mix this method with the InsertEdge() method that follows.
void InsertEdge (int p1, int p2, int attributeId)
 Insert the edge (p1,p2) into the table with the attribute id specified (make sure the attributeId >= 0). Note that the attributeId is ignored if the storeAttributes variable was set to 0 in the InitEdgeInsertion() method. It is the user's responsibility to check if the edge has already been inserted (use IsEdge()). Do not mix this method with the other two InsertEdge() methods.
void InsertEdge (int p1, int p2, IntPtr ptr)
 Insert the edge (p1,p2) into the table with the attribute id specified (make sure the attributeId >= 0). Note that the attributeId is ignored if the storeAttributes variable was set to 0 in the InitEdgeInsertion() method. It is the user's responsibility to check if the edge has already been inserted (use IsEdge()). Do not mix this method with the other two InsertEdge() methods.
int InsertUniquePoint (int p1, int p2, IntPtr x, ref int ptId)
 Insert a unique point on the specified edge. Invoke this method only after InitPointInsertion() has been called. Return 0 if point was already in the list, otherwise return 1.
override int IsA (string type)
 Instantiate object assuming that 1000 edges are to be inserted.
int IsEdge (int p1, int p2)
 Return an integer id for the edge, or an attribute id of the edge (p1,p2) if the edge has been previously defined (it depends upon which version of InsertEdge() is being used); otherwise -1. The unique integer id can be used to set and retrieve attributes to the edge.
new vtkEdgeTable NewInstance ()
 Instantiate object assuming that 1000 edges are to be inserted.
void Reset ()
 Reset the object and prepare for reinsertion of edges. Does not delete memory like the Initialize() method.

Static Public Member Functions

static new vtkEdgeTable New ()
 Instantiate object assuming that 1000 edges are to be inserted.
static new int IsTypeOf (string type)
 Instantiate object assuming that 1000 edges are to be inserted.
static new vtkEdgeTable SafeDownCast (vtkObjectBase o)
 Instantiate object assuming that 1000 edges are to be inserted.

Public Attributes

new const string MRFullTypeName = "Kitware.VTK.vtkEdgeTable"
 Automatically generated type registration mechanics.

Static Public Attributes

static new readonly string MRClassNameKey = "12vtkEdgeTable"
 Automatically generated type registration mechanics.

Protected Member Functions

override void Dispose (bool disposing)
 Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Private Member Functions

static internal IntPtr vtkEdgeTable_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtkEdgeTable_GetNextEdge_01 (HandleRef pThis, ref int p1, ref int p2)
static internal int vtkEdgeTable_GetNumberOfEdges_02 (HandleRef pThis)
static internal int vtkEdgeTable_InitEdgeInsertion_03 (HandleRef pThis, int numPoints, int storeAttributes)
static internal int vtkEdgeTable_InitPointInsertion_04 (HandleRef pThis, HandleRef newPts, int estSize)
static internal void vtkEdgeTable_InitTraversal_05 (HandleRef pThis)
static internal void vtkEdgeTable_Initialize_06 (HandleRef pThis)
static internal int vtkEdgeTable_InsertEdge_07 (HandleRef pThis, int p1, int p2)
static internal void vtkEdgeTable_InsertEdge_08 (HandleRef pThis, int p1, int p2, int attributeId)
static internal void vtkEdgeTable_InsertEdge_09 (HandleRef pThis, int p1, int p2, IntPtr ptr)
static internal int vtkEdgeTable_InsertUniquePoint_10 (HandleRef pThis, int p1, int p2, IntPtr x, ref int ptId)
static internal int vtkEdgeTable_IsA_11 (HandleRef pThis, string type)
static internal int vtkEdgeTable_IsEdge_12 (HandleRef pThis, int p1, int p2)
static internal int vtkEdgeTable_IsTypeOf_13 (string type)
static internal IntPtr vtkEdgeTable_NewInstance_15 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkEdgeTable_Reset_16 (HandleRef pThis)
static internal IntPtr vtkEdgeTable_SafeDownCast_17 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)

Static Private Member Functions

static vtkEdgeTable ()
 Automatically generated type registration mechanics.

Detailed Description

vtkEdgeTable - keep track of edges (edge is pair of integer id's)

Description vtkEdgeTable is a general object for keeping track of lists of edges. An edge is defined by the pair of point id's (p1,p2). Methods are available to insert edges, check if edges exist, and traverse the list of edges. Also, it's possible to associate attribute information with each edge. The attribute information may take the form of vtkIdType id's, void* pointers, or points. To store attributes, make sure that InitEdgeInsertion() is invoked with the storeAttributes flag set properly. If points are inserted, use the methods InitPointInsertion() and InsertUniquePoint().


Constructor & Destructor Documentation

static Kitware.VTK.vtkEdgeTable.vtkEdgeTable ( ) [static, private]

Automatically generated type registration mechanics.

Kitware.VTK.vtkEdgeTable.vtkEdgeTable ( IntPtr  rawCppThis,
bool  callDisposalMethod,
bool  strong 
)

Automatically generated constructor - called from generated code. DO NOT call directly.

Instantiate object assuming that 1000 edges are to be inserted.


Member Function Documentation

override void Kitware.VTK.vtkEdgeTable.Dispose ( bool  disposing) [protected]

Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Reimplemented from Kitware.VTK.vtkObject.

int Kitware.VTK.vtkEdgeTable.GetNextEdge ( ref int  p1,
ref int  p2 
)

Traverse list of edges in table. Return the edge as (p1,p2), where p1 and p2 are point id's. Method return value is <0 if list is exhausted; non-zero otherwise. The value of p1 is guaranteed to be <= p2.

virtual int Kitware.VTK.vtkEdgeTable.GetNumberOfEdges ( ) [virtual]

Return the number of edges that have been inserted thus far.

int Kitware.VTK.vtkEdgeTable.InitEdgeInsertion ( int  numPoints,
int  storeAttributes 
)

Initialize the edge insertion process. Provide an estimate of the number of points in a dataset (the maximum range value of p1 or p2). The storeAttributes variable controls whether attributes are to be stored with the edge, and what type of attributes. If storeAttributes==1, then attributes of vtkIdType can be stored. If storeAttributes==2, then attributes of type void* can be stored. In either case, additional memory will be required by the data structure to store attribute data per each edge. This method is used in conjunction with one of the three InsertEdge() methods described below (don't mix the InsertEdge() methods---make sure that the one used is consistent with the storeAttributes flag set in InitEdgeInsertion()).

Free memory and return to the initially instantiated state.

int Kitware.VTK.vtkEdgeTable.InitPointInsertion ( vtkPoints  newPts,
int  estSize 
)

Initialize the point insertion process. The newPts is an object representing point coordinates into which incremental insertion methods place their data. The points are associated with the edge.

Intialize traversal of edges in table.

int Kitware.VTK.vtkEdgeTable.InsertEdge ( int  p1,
int  p2 
)

Insert the edge (p1,p2) into the table. It is the user's responsibility to check if the edge has already been inserted (use IsEdge()). If the storeAttributes flag in InitEdgeInsertion() has been set, then the method returns a unique integer id (i.e., the edge id) that can be used to set and get edge attributes. Otherwise, the method will return 1. Do not mix this method with the InsertEdge() method that follows.

void Kitware.VTK.vtkEdgeTable.InsertEdge ( int  p1,
int  p2,
int  attributeId 
)

Insert the edge (p1,p2) into the table with the attribute id specified (make sure the attributeId >= 0). Note that the attributeId is ignored if the storeAttributes variable was set to 0 in the InitEdgeInsertion() method. It is the user's responsibility to check if the edge has already been inserted (use IsEdge()). Do not mix this method with the other two InsertEdge() methods.

void Kitware.VTK.vtkEdgeTable.InsertEdge ( int  p1,
int  p2,
IntPtr  ptr 
)

Insert the edge (p1,p2) into the table with the attribute id specified (make sure the attributeId >= 0). Note that the attributeId is ignored if the storeAttributes variable was set to 0 in the InitEdgeInsertion() method. It is the user's responsibility to check if the edge has already been inserted (use IsEdge()). Do not mix this method with the other two InsertEdge() methods.

int Kitware.VTK.vtkEdgeTable.InsertUniquePoint ( int  p1,
int  p2,
IntPtr  x,
ref int  ptId 
)

Insert a unique point on the specified edge. Invoke this method only after InitPointInsertion() has been called. Return 0 if point was already in the list, otherwise return 1.

override int Kitware.VTK.vtkEdgeTable.IsA ( string  type) [virtual]

Instantiate object assuming that 1000 edges are to be inserted.

Reimplemented from Kitware.VTK.vtkObject.

int Kitware.VTK.vtkEdgeTable.IsEdge ( int  p1,
int  p2 
)

Return an integer id for the edge, or an attribute id of the edge (p1,p2) if the edge has been previously defined (it depends upon which version of InsertEdge() is being used); otherwise -1. The unique integer id can be used to set and retrieve attributes to the edge.

static new int Kitware.VTK.vtkEdgeTable.IsTypeOf ( string  type) [static]

Instantiate object assuming that 1000 edges are to be inserted.

Reimplemented from Kitware.VTK.vtkObject.

static new vtkEdgeTable Kitware.VTK.vtkEdgeTable.New ( ) [static]

Instantiate object assuming that 1000 edges are to be inserted.

Reimplemented from Kitware.VTK.vtkObject.

Instantiate object assuming that 1000 edges are to be inserted.

Reimplemented from Kitware.VTK.vtkObject.

Reset the object and prepare for reinsertion of edges. Does not delete memory like the Initialize() method.

Instantiate object assuming that 1000 edges are to be inserted.

Reimplemented from Kitware.VTK.vtkObject.

Here is the call graph for this function:

static internal int Kitware.VTK.vtkEdgeTable.vtkEdgeTable_GetNextEdge_01 ( HandleRef  pThis,
ref int  p1,
ref int  p2 
) [private]
static internal int Kitware.VTK.vtkEdgeTable.vtkEdgeTable_GetNumberOfEdges_02 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkEdgeTable.vtkEdgeTable_InitEdgeInsertion_03 ( HandleRef  pThis,
int  numPoints,
int  storeAttributes 
) [private]
static internal void Kitware.VTK.vtkEdgeTable.vtkEdgeTable_Initialize_06 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkEdgeTable.vtkEdgeTable_InitPointInsertion_04 ( HandleRef  pThis,
HandleRef  newPts,
int  estSize 
) [private]
static internal void Kitware.VTK.vtkEdgeTable.vtkEdgeTable_InitTraversal_05 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkEdgeTable.vtkEdgeTable_InsertEdge_07 ( HandleRef  pThis,
int  p1,
int  p2 
) [private]
static internal void Kitware.VTK.vtkEdgeTable.vtkEdgeTable_InsertEdge_08 ( HandleRef  pThis,
int  p1,
int  p2,
int  attributeId 
) [private]
static internal void Kitware.VTK.vtkEdgeTable.vtkEdgeTable_InsertEdge_09 ( HandleRef  pThis,
int  p1,
int  p2,
IntPtr  ptr 
) [private]
static internal int Kitware.VTK.vtkEdgeTable.vtkEdgeTable_InsertUniquePoint_10 ( HandleRef  pThis,
int  p1,
int  p2,
IntPtr  x,
ref int  ptId 
) [private]
static internal int Kitware.VTK.vtkEdgeTable.vtkEdgeTable_IsA_11 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkEdgeTable.vtkEdgeTable_IsEdge_12 ( HandleRef  pThis,
int  p1,
int  p2 
) [private]
static internal int Kitware.VTK.vtkEdgeTable.vtkEdgeTable_IsTypeOf_13 ( string  type) [private]
static internal IntPtr Kitware.VTK.vtkEdgeTable.vtkEdgeTable_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkEdgeTable.vtkEdgeTable_NewInstance_15 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkEdgeTable.vtkEdgeTable_Reset_16 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkEdgeTable.vtkEdgeTable_SafeDownCast_17 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkEdgeTable.MRClassNameKey = "12vtkEdgeTable" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkObject.

new const string Kitware.VTK.vtkEdgeTable.MRFullTypeName = "Kitware.VTK.vtkEdgeTable"

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkObject.


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