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

vtkDataSetEdgeSubdivisionCriterion - a subclass of vtkEdgeSubdivisionCriterion for vtkDataSet objects. More...

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

List of all members.

Public Member Functions

 vtkDataSetEdgeSubdivisionCriterion (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkDataSetEdgeSubdivisionCriterion ()
 *Undocumented Block
void EvaluateCellDataField (IntPtr result, IntPtr weights, int field)
 Evaluate either a cell or nodal field. This exists because of the funky way that Exodus data will be handled. Sure, it's a hack, but what are ya gonna do?
override bool EvaluateEdge (IntPtr p0, IntPtr midpt, IntPtr p1, int field_start)
 *Undocumented Block
IntPtr EvaluateFields (IntPtr vertex, IntPtr weights, int field_start)
 Evaluate all of the fields that should be output with the given vertex and store them just past the parametric coordinates of vertex, at the offsets given by vtkEdgeSubdivisionCriterion::GetFieldOffsets() plus field_start. field_start contains the number of world-space coordinates (always 3) plus the embedding dimension (the size of the parameter-space in which the cell is embedded). It will range between 3 and 6, inclusive.
void EvaluatePointDataField (IntPtr result, IntPtr weights, int field)
 Evaluate either a cell or nodal field. This exists because of the funky way that Exodus data will be handled. Sure, it's a hack, but what are ya gonna do?
virtual int GetActiveFieldCriteria ()
 Return a bitfield specifying which FieldError2 criteria are positive (i.e., actively used to decide edge subdivisions). This is stored as separate state to make subdivisions go faster.
vtkCell GetCell ()
 Return a bitfield specifying which FieldError2 criteria are positive (i.e., actively used to decide edge subdivisions). This is stored as separate state to make subdivisions go faster.
int GetCellId ()
 Return a bitfield specifying which FieldError2 criteria are positive (i.e., actively used to decide edge subdivisions). This is stored as separate state to make subdivisions go faster.
virtual double GetChordError2 ()
 Get/Set the square of the allowable chord error at any edge's midpoint. This value is used by EvaluateEdge.
double GetFieldError2 (int s)
 Get/Set the square of the allowable error magnitude for the scalar field s at any edge's midpoint. A value less than or equal to 0 indicates that the field should not be used as a criterion for subdivision.
vtkDataSet GetMesh ()
 Return a bitfield specifying which FieldError2 criteria are positive (i.e., actively used to decide edge subdivisions). This is stored as separate state to make subdivisions go faster.
override int IsA (string type)
 *Undocumented Block
new
vtkDataSetEdgeSubdivisionCriterion 
NewInstance ()
 *Undocumented Block
virtual void ResetFieldError2 ()
 Tell the subdivider not to use any field values as subdivision criteria. Effectively calls SetFieldError2( a, -1. ) for all fields.
virtual void SetCellId (int cell)
 *Undocumented Block
virtual void SetChordError2 (double _arg)
 Get/Set the square of the allowable chord error at any edge's midpoint. This value is used by EvaluateEdge.
virtual void SetFieldError2 (int s, double err)
 Get/Set the square of the allowable error magnitude for the scalar field s at any edge's midpoint. A value less than or equal to 0 indicates that the field should not be used as a criterion for subdivision.
virtual void SetMesh (vtkDataSet arg0)
 *Undocumented Block
- Public Member Functions inherited from Kitware.VTK.vtkEdgeSubdivisionCriterion
 vtkEdgeSubdivisionCriterion (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
virtual bool DontPassField (int sourceId, vtkStreamingTessellator t)
 This does the opposite of PassField(); it removes a field from the output (assuming the field was set to be passed). Returns true if any action was taken, false otherwise.
IntPtr GetFieldIds ()
 Perform the core logic for a fixed multi-criterion, scalar-field based subdivision. Returns true if subdivision should occur, false otherwise. This is to be used by subclasses once the mesh-specific evaluation routines have been called to get the actual (as opposed to linearly interpolated) midpoint geometry and field values. Only field values are tested (not geometry) because you can save yourself field evaluations if you check the geometry yourself and it fails the test.
IntPtr GetFieldOffsets ()
 Perform the core logic for a fixed multi-criterion, scalar-field based subdivision. Returns true if subdivision should occur, false otherwise. This is to be used by subclasses once the mesh-specific evaluation routines have been called to get the actual (as opposed to linearly interpolated) midpoint geometry and field values. Only field values are tested (not geometry) because you can save yourself field evaluations if you check the geometry yourself and it fails the test.
int GetNumberOfFields ()
 Perform the core logic for a fixed multi-criterion, scalar-field based subdivision. Returns true if subdivision should occur, false otherwise. This is to be used by subclasses once the mesh-specific evaluation routines have been called to get the actual (as opposed to linearly interpolated) midpoint geometry and field values. Only field values are tested (not geometry) because you can save yourself field evaluations if you check the geometry yourself and it fails the test.
int GetOutputField (int fieldId)
 Return the output ID of an input field. Returns -1 if fieldId is not set to be passed to the output.
virtual int PassField (int sourceId, int sourceSize, vtkStreamingTessellator t)
 This is a helper routine called by PassFields() which you may also call directly; it adds sourceSize to the size of the output vertex field values. The offset of the sourceId field in the output vertex array is returned. -1 is returned if sourceSize would force the output to have more than vtkStreamingTessellator::MaxFieldSize field values per vertex.
virtual void ResetFieldList ()
 Don't pass any field values in the vertex pointer. This is used to reset the list of fields to pass after a successful run of vtkStreamingTessellator.
- Public Member Functions inherited from Kitware.VTK.vtkObject
 vtkObject (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkObject ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
uint AddObserver (uint arg0, vtkCommand arg1, float priority)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
uint AddObserver (string arg0, vtkCommand arg1, float priority)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
virtual void DebugOff ()
 Turn debugging output off.
virtual void DebugOn ()
 Turn debugging output on.
vtkCommand GetCommand (uint tag)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
byte GetDebug ()
 Get the value of the debug flag.
virtual uint GetMTime ()
 Return this object's modified time.
int HasObserver (uint arg0, vtkCommand arg1)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int HasObserver (string arg0, vtkCommand arg1)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int HasObserver (uint arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int HasObserver (string arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int InvokeEvent (uint arg0, IntPtr callData)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int InvokeEvent (string arg0, IntPtr callData)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int InvokeEvent (uint arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
int InvokeEvent (string arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
virtual void Modified ()
 Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data. The modification time is a unique monotonically increasing unsigned long integer.
void RemoveAllObservers ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObserver (vtkCommand arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObserver (uint tag)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObservers (uint arg0, vtkCommand arg1)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObservers (string arg0, vtkCommand arg1)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObservers (uint arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void RemoveObservers (string arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
void SetDebug (byte debugFlag)
 Set the value of the debug flag. A non-zero value turns debugging on.
override string ToString ()
 Returns the result of calling vtkObject::Print as a C# string.
delegate void vtkObjectEventHandler (vtkObject sender, vtkObjectEventArgs e)
 Generic signature for all vtkObject events.
void RemoveAllHandlersForAllEvents ()
 Call RemoveAllHandlers on each non-null vtkObjectEventRelay. TODO: This method needs to get called by the generated Dispose. Make that happen...
- Public Member Functions inherited from Kitware.VTK.vtkObjectBase
 vtkObjectBase (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkObjectBase ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
virtual void Register (vtkObjectBase o)
 Increase the reference count (mark as used by another object).
virtual void FastDelete ()
 Delete a reference to this object. This version will not invoke garbage collection and can potentially leak the object if it is part of a reference loop. Use this method only when it is known that the object has another reference and would not be collected if a full garbage collection check were done.
string GetClassName ()
 Return the class name as a string. This method is defined in all subclasses of vtkObjectBase with the vtkTypeMacro found in vtkSetGet.h.
int GetReferenceCount ()
 Return the current reference count of this object.
void SetReferenceCount (int arg0)
 Sets the reference count. (This is very dangerous, use with care.)

Static Public Member Functions

static new
vtkDataSetEdgeSubdivisionCriterion 
New ()
 *Undocumented Block
static new int IsTypeOf (string type)
 *Undocumented Block
static new
vtkDataSetEdgeSubdivisionCriterion 
SafeDownCast (vtkObjectBase o)
 *Undocumented Block

Public Attributes

new const string MRFullTypeName = "Kitware.VTK.vtkDataSetEdgeSubdivisionCriterion"
 Automatically generated type registration mechanics.
- Public Attributes inherited from Kitware.VTK.vtkEdgeSubdivisionCriterion
- Public Attributes inherited from Kitware.VTK.vtkObject
- Public Attributes inherited from Kitware.VTK.vtkObjectBase
- Public Attributes inherited from Kitware.VTK.WrappedObject
const string vtkChartsEL_dll = "libKitware.VTK.vtkCharts.Unmanaged.so"
 Export layer functions for 'vtkCharts' are exported from the DLL named by the value of this variable.
const string vtkCommonEL_dll = "libKitware.VTK.vtkCommon.Unmanaged.so"
 Export layer functions for 'vtkCommon' are exported from the DLL named by the value of this variable.
const string vtkFilteringEL_dll = "libKitware.VTK.vtkFiltering.Unmanaged.so"
 Export layer functions for 'vtkFiltering' are exported from the DLL named by the value of this variable.
const string vtkGenericFilteringEL_dll = "libKitware.VTK.vtkGenericFiltering.Unmanaged.so"
 Export layer functions for 'vtkGenericFiltering' are exported from the DLL named by the value of this variable.
const string vtkGeovisEL_dll = "libKitware.VTK.vtkGeovis.Unmanaged.so"
 Export layer functions for 'vtkGeovis' are exported from the DLL named by the value of this variable.
const string vtkGraphicsEL_dll = "libKitware.VTK.vtkGraphics.Unmanaged.so"
 Export layer functions for 'vtkGraphics' are exported from the DLL named by the value of this variable.
const string vtkHybridEL_dll = "libKitware.VTK.vtkHybrid.Unmanaged.so"
 Export layer functions for 'vtkHybrid' are exported from the DLL named by the value of this variable.
const string vtkIOEL_dll = "libKitware.VTK.vtkIO.Unmanaged.so"
 Export layer functions for 'vtkIO' are exported from the DLL named by the value of this variable.
const string vtkImagingEL_dll = "libKitware.VTK.vtkImaging.Unmanaged.so"
 Export layer functions for 'vtkImaging' are exported from the DLL named by the value of this variable.
const string vtkInfovisEL_dll = "libKitware.VTK.vtkInfovis.Unmanaged.so"
 Export layer functions for 'vtkInfovis' are exported from the DLL named by the value of this variable.
const string vtkParallelEL_dll = "libKitware.VTK.vtkParallel.Unmanaged.so"
 Export layer functions for 'vtkParallel' are exported from the DLL named by the value of this variable.
const string vtkRenderingEL_dll = "libKitware.VTK.vtkRendering.Unmanaged.so"
 Export layer functions for 'vtkRendering' are exported from the DLL named by the value of this variable.
const string vtkViewsEL_dll = "libKitware.VTK.vtkViews.Unmanaged.so"
 Export layer functions for 'vtkViews' are exported from the DLL named by the value of this variable.
const string vtkVolumeRenderingEL_dll = "libKitware.VTK.vtkVolumeRendering.Unmanaged.so"
 Export layer functions for 'vtkVolumeRendering' are exported from the DLL named by the value of this variable.
const string vtkWidgetsEL_dll = "libKitware.VTK.vtkWidgets.Unmanaged.so"
 Export layer functions for 'vtkWidgets' are exported from the DLL named by the value of this variable.

Static Public Attributes

static new readonly string MRClassNameKey = "34vtkDataSetEdgeSubdivisionCriterion"
 Automatically generated type registration mechanics.
- Static Public Attributes inherited from Kitware.VTK.vtkEdgeSubdivisionCriterion
- Static Public Attributes inherited from Kitware.VTK.vtkObject
- Static Public Attributes inherited from Kitware.VTK.vtkObjectBase

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.

Static Private Member Functions

static vtkDataSetEdgeSubdivisionCriterion ()
 Automatically generated type registration mechanics.

Detailed Description

vtkDataSetEdgeSubdivisionCriterion - a subclass of vtkEdgeSubdivisionCriterion for vtkDataSet objects.

Description This is a subclass of vtkEdgeSubdivisionCriterion that is used for tessellating cells of a vtkDataSet, particularly nonlinear cells.

It provides functions for setting the current cell being tessellated and a convenience routine, EvaluateFields() to evaluate field values at a point. You should call EvaluateFields() from inside EvaluateEdge() whenever the result of EvaluateEdge() will be true. Otherwise, do not call EvaluateFields() as the midpoint is about to be discarded. (<i>Implementor's note</i>: This isn't true if UGLY_ASPECT_RATIO_HACK has been defined. But in that case, we don't want the exact field values; we need the linearly interpolated ones at the midpoint for continuity.)

vtkEdgeSubdivisionCriterion


Constructor & Destructor Documentation

static Kitware.VTK.vtkDataSetEdgeSubdivisionCriterion.vtkDataSetEdgeSubdivisionCriterion ( )
staticprivate

Automatically generated type registration mechanics.

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

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

Kitware.VTK.vtkDataSetEdgeSubdivisionCriterion.vtkDataSetEdgeSubdivisionCriterion ( )

*Undocumented Block


Member Function Documentation

override void Kitware.VTK.vtkDataSetEdgeSubdivisionCriterion.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.vtkEdgeSubdivisionCriterion.

void Kitware.VTK.vtkDataSetEdgeSubdivisionCriterion.EvaluateCellDataField ( IntPtr  result,
IntPtr  weights,
int  field 
)

Evaluate either a cell or nodal field. This exists because of the funky way that Exodus data will be handled. Sure, it's a hack, but what are ya gonna do?

override bool Kitware.VTK.vtkDataSetEdgeSubdivisionCriterion.EvaluateEdge ( IntPtr  p0,
IntPtr  midpt,
IntPtr  p1,
int  field_start 
)
virtual

*Undocumented Block

Reimplemented from Kitware.VTK.vtkEdgeSubdivisionCriterion.

IntPtr Kitware.VTK.vtkDataSetEdgeSubdivisionCriterion.EvaluateFields ( IntPtr  vertex,
IntPtr  weights,
int  field_start 
)

Evaluate all of the fields that should be output with the given vertex and store them just past the parametric coordinates of vertex, at the offsets given by vtkEdgeSubdivisionCriterion::GetFieldOffsets() plus field_start. field_start contains the number of world-space coordinates (always 3) plus the embedding dimension (the size of the parameter-space in which the cell is embedded). It will range between 3 and 6, inclusive.

You must have called SetCellId() before calling this routine or there will not be a mesh over which to evaluate the fields.

You must have called vtkEdgeSubdivisionCriterion::PassDefaultFields() or vtkEdgeSubdivisionCriterion::PassField() or there will be no fields defined for the output vertex.

This routine is public and returns its input argument so that it may be used as an argument to vtkStreamingTessellator::AdaptivelySamplekFacet():

   ///   vtkStreamingTessellator* t = vtkStreamingTessellator::New();
   ///   vtkEdgeSubdivisionCriterion* s;
   ///   ...
   ///   t-&gt;AdaptivelySample1Facet( s-&gt;EvaluateFields( p0 ), s-&gt;EvaluateFields( p1 ) );
   ///   ...
   /// 

Although this will work, using EvaluateFields() in this manner should be avoided. It's much more efficient to fetch the corner values for each attribute and copy them into p0, p1, ... as opposed to performing shape function evaluations. The only case where you wouldn't want to do this is when the field you are interpolating is discontinuous at cell borders, such as with a discontinuous galerkin method or when all the Gauss points for quadrature are interior to the cell.

The final argument, weights, is the array of weights to apply to each point's data when interpolating the field. This is returned by vtkCell::EvaluateLocation() when evaluating the geometry.

void Kitware.VTK.vtkDataSetEdgeSubdivisionCriterion.EvaluatePointDataField ( IntPtr  result,
IntPtr  weights,
int  field 
)

Evaluate either a cell or nodal field. This exists because of the funky way that Exodus data will be handled. Sure, it's a hack, but what are ya gonna do?

virtual int Kitware.VTK.vtkDataSetEdgeSubdivisionCriterion.GetActiveFieldCriteria ( )
virtual

Return a bitfield specifying which FieldError2 criteria are positive (i.e., actively used to decide edge subdivisions). This is stored as separate state to make subdivisions go faster.

vtkCell Kitware.VTK.vtkDataSetEdgeSubdivisionCriterion.GetCell ( )

Return a bitfield specifying which FieldError2 criteria are positive (i.e., actively used to decide edge subdivisions). This is stored as separate state to make subdivisions go faster.

Here is the call graph for this function:

int Kitware.VTK.vtkDataSetEdgeSubdivisionCriterion.GetCellId ( )

Return a bitfield specifying which FieldError2 criteria are positive (i.e., actively used to decide edge subdivisions). This is stored as separate state to make subdivisions go faster.

virtual double Kitware.VTK.vtkDataSetEdgeSubdivisionCriterion.GetChordError2 ( )
virtual

Get/Set the square of the allowable chord error at any edge's midpoint. This value is used by EvaluateEdge.

double Kitware.VTK.vtkDataSetEdgeSubdivisionCriterion.GetFieldError2 ( int  s)

Get/Set the square of the allowable error magnitude for the scalar field s at any edge's midpoint. A value less than or equal to 0 indicates that the field should not be used as a criterion for subdivision.

vtkDataSet Kitware.VTK.vtkDataSetEdgeSubdivisionCriterion.GetMesh ( )

Return a bitfield specifying which FieldError2 criteria are positive (i.e., actively used to decide edge subdivisions). This is stored as separate state to make subdivisions go faster.

Here is the call graph for this function:

override int Kitware.VTK.vtkDataSetEdgeSubdivisionCriterion.IsA ( string  type)
virtual

*Undocumented Block

Reimplemented from Kitware.VTK.vtkEdgeSubdivisionCriterion.

static new int Kitware.VTK.vtkDataSetEdgeSubdivisionCriterion.IsTypeOf ( string  type)
static

*Undocumented Block

Reimplemented from Kitware.VTK.vtkEdgeSubdivisionCriterion.

static new vtkDataSetEdgeSubdivisionCriterion Kitware.VTK.vtkDataSetEdgeSubdivisionCriterion.New ( )
static

*Undocumented Block

Reimplemented from Kitware.VTK.vtkObject.

new vtkDataSetEdgeSubdivisionCriterion Kitware.VTK.vtkDataSetEdgeSubdivisionCriterion.NewInstance ( )

*Undocumented Block

Reimplemented from Kitware.VTK.vtkEdgeSubdivisionCriterion.

virtual void Kitware.VTK.vtkDataSetEdgeSubdivisionCriterion.ResetFieldError2 ( )
virtual

Tell the subdivider not to use any field values as subdivision criteria. Effectively calls SetFieldError2( a, -1. ) for all fields.

static new vtkDataSetEdgeSubdivisionCriterion Kitware.VTK.vtkDataSetEdgeSubdivisionCriterion.SafeDownCast ( vtkObjectBase  o)
static

*Undocumented Block

Reimplemented from Kitware.VTK.vtkEdgeSubdivisionCriterion.

Here is the call graph for this function:

virtual void Kitware.VTK.vtkDataSetEdgeSubdivisionCriterion.SetCellId ( int  cell)
virtual

*Undocumented Block

virtual void Kitware.VTK.vtkDataSetEdgeSubdivisionCriterion.SetChordError2 ( double  _arg)
virtual

Get/Set the square of the allowable chord error at any edge's midpoint. This value is used by EvaluateEdge.

virtual void Kitware.VTK.vtkDataSetEdgeSubdivisionCriterion.SetFieldError2 ( int  s,
double  err 
)
virtual

Get/Set the square of the allowable error magnitude for the scalar field s at any edge's midpoint. A value less than or equal to 0 indicates that the field should not be used as a criterion for subdivision.

virtual void Kitware.VTK.vtkDataSetEdgeSubdivisionCriterion.SetMesh ( vtkDataSet  arg0)
virtual

*Undocumented Block


Member Data Documentation

new readonly string Kitware.VTK.vtkDataSetEdgeSubdivisionCriterion.MRClassNameKey = "34vtkDataSetEdgeSubdivisionCriterion"
static

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkEdgeSubdivisionCriterion.

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

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkEdgeSubdivisionCriterion.


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