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.vtkParticleReader Class Reference

vtkParticleReader - Read ASCII or binary particle data and (optionally) one scalar value associated with each particle. More...

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

List of all members.

Public Member Functions

 vtkParticleReader (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkParticleReader ()
 *Undocumented Block
int GetDataByteOrder ()
 These methods should be used instead of the SwapBytes methods. They indicate the byte ordering of the file you are trying to read in. These methods will then either swap or not swap the bytes depending on the byte ordering of the machine it is being run on. For example, reading in a BigEndian file on a BigEndian machine will result in no swapping. Trying to read the same file on a LittleEndian machine will result in swapping. As a quick note most UNIX machines are BigEndian while PC's and VAX tend to be LittleEndian. So if the file you are reading in was generated on a VAX or PC, SetDataByteOrderToLittleEndian otherwise SetDataByteOrderToBigEndian. Not used when reading text files.
string GetDataByteOrderAsString ()
 These methods should be used instead of the SwapBytes methods. They indicate the byte ordering of the file you are trying to read in. These methods will then either swap or not swap the bytes depending on the byte ordering of the machine it is being run on. For example, reading in a BigEndian file on a BigEndian machine will result in no swapping. Trying to read the same file on a LittleEndian machine will result in swapping. As a quick note most UNIX machines are BigEndian while PC's and VAX tend to be LittleEndian. So if the file you are reading in was generated on a VAX or PC, SetDataByteOrderToLittleEndian otherwise SetDataByteOrderToBigEndian. Not used when reading text files.
virtual int GetDataType ()
 Get/Set the data type. The options are:
virtual int GetDataTypeMaxValue ()
 Get/Set the data type. The options are:
virtual int GetDataTypeMinValue ()
 Get/Set the data type. The options are:
virtual string GetFileName ()
 Specify file name.
virtual int GetFileType ()
 Get/Set the file type. The options are:
virtual int GetFileTypeMaxValue ()
 Get/Set the file type. The options are:
virtual int GetFileTypeMinValue ()
 Get/Set the file type. The options are:
virtual int GetHasScalar ()
 Default: 1. If 1 then each particle has a value associated with it.
int GetSwapBytes ()
 Set/Get the byte swapping to explicitly swap the bytes of a file. Not used when reading text files.
virtual void HasScalarOff ()
 Default: 1. If 1 then each particle has a value associated with it.
virtual void HasScalarOn ()
 Default: 1. If 1 then each particle has a value associated with it.
override int IsA (string type)
 *Undocumented Block
new vtkParticleReader NewInstance ()
 *Undocumented Block
void SetDataByteOrder (int arg0)
 These methods should be used instead of the SwapBytes methods. They indicate the byte ordering of the file you are trying to read in. These methods will then either swap or not swap the bytes depending on the byte ordering of the machine it is being run on. For example, reading in a BigEndian file on a BigEndian machine will result in no swapping. Trying to read the same file on a LittleEndian machine will result in swapping. As a quick note most UNIX machines are BigEndian while PC's and VAX tend to be LittleEndian. So if the file you are reading in was generated on a VAX or PC, SetDataByteOrderToLittleEndian otherwise SetDataByteOrderToBigEndian. Not used when reading text files.
void SetDataByteOrderToBigEndian ()
 These methods should be used instead of the SwapBytes methods. They indicate the byte ordering of the file you are trying to read in. These methods will then either swap or not swap the bytes depending on the byte ordering of the machine it is being run on. For example, reading in a BigEndian file on a BigEndian machine will result in no swapping. Trying to read the same file on a LittleEndian machine will result in swapping. As a quick note most UNIX machines are BigEndian while PC's and VAX tend to be LittleEndian. So if the file you are reading in was generated on a VAX or PC, SetDataByteOrderToLittleEndian otherwise SetDataByteOrderToBigEndian. Not used when reading text files.
void SetDataByteOrderToLittleEndian ()
 These methods should be used instead of the SwapBytes methods. They indicate the byte ordering of the file you are trying to read in. These methods will then either swap or not swap the bytes depending on the byte ordering of the machine it is being run on. For example, reading in a BigEndian file on a BigEndian machine will result in no swapping. Trying to read the same file on a LittleEndian machine will result in swapping. As a quick note most UNIX machines are BigEndian while PC's and VAX tend to be LittleEndian. So if the file you are reading in was generated on a VAX or PC, SetDataByteOrderToLittleEndian otherwise SetDataByteOrderToBigEndian. Not used when reading text files.
virtual void SetDataType (int _arg)
 Get/Set the data type. The options are:
void SetDataTypeToDouble ()
 Get/Set the data type. The options are:
void SetDataTypeToFloat ()
 Get/Set the data type. The options are:
virtual void SetFileName (string _arg)
 Specify file name.
virtual void SetFileType (int _arg)
 Get/Set the file type. The options are:
void SetFileTypeToBinary ()
 Get/Set the file type. The options are:
void SetFileTypeToText ()
 Get/Set the file type. The options are:
void SetFileTypeToUnknown ()
 Get/Set the file type. The options are:
virtual void SetHasScalar (int _arg)
 Default: 1. If 1 then each particle has a value associated with it.
virtual void SetSwapBytes (int _arg)
 Set/Get the byte swapping to explicitly swap the bytes of a file. Not used when reading text files.
virtual void SwapBytesOff ()
 Set/Get the byte swapping to explicitly swap the bytes of a file. Not used when reading text files.
virtual void SwapBytesOn ()
 Set/Get the byte swapping to explicitly swap the bytes of a file. Not used when reading text files.
- Public Member Functions inherited from Kitware.VTK.vtkPolyDataAlgorithm
 vtkPolyDataAlgorithm (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkPolyDataAlgorithm ()
 *Undocumented Block
void AddInput (vtkDataObject arg0)
 Add an input of this algorithm. Note that these methods support old-style pipeline connections. When writing new code you should use the more general vtkAlgorithm::AddInputConnection(). See SetInput() for details.
void AddInput (int arg0, vtkDataObject arg1)
 Add an input of this algorithm. Note that these methods support old-style pipeline connections. When writing new code you should use the more general vtkAlgorithm::AddInputConnection(). See SetInput() for details.
vtkDataObject GetInput ()
 this method is not recommended for use, but lots of old style filters use it
vtkDataObject GetInput (int port)
 this method is not recommended for use, but lots of old style filters use it
vtkPolyData GetOutput ()
 Get the output data object for a port on this algorithm.
vtkPolyData GetOutput (int arg0)
 Get the output data object for a port on this algorithm.
vtkPolyData GetPolyDataInput (int port)
 this method is not recommended for use, but lots of old style filters use it
void SetInput (vtkDataObject arg0)
 Set an input of this algorithm. You should not override these methods because they are not the only way to connect a pipeline. Note that these methods support old-style pipeline connections. When writing new code you should use the more general vtkAlgorithm::SetInputConnection(). These methods transform the input index to the input port index, not an index of a connection within a single port.
void SetInput (int arg0, vtkDataObject arg1)
 Set an input of this algorithm. You should not override these methods because they are not the only way to connect a pipeline. Note that these methods support old-style pipeline connections. When writing new code you should use the more general vtkAlgorithm::SetInputConnection(). These methods transform the input index to the input port index, not an index of a connection within a single port.
virtual void SetOutput (vtkDataObject d)
 Get the output data object for a port on this algorithm.
- Public Member Functions inherited from Kitware.VTK.vtkAlgorithm
 vtkAlgorithm (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkAlgorithm ()
 *Undocumented Block
override void Register (vtkObjectBase o)
 Participate in garbage collection.
virtual void AbortExecuteOff ()
 Set/Get the AbortExecute flag for the process object. Process objects may handle premature termination of execution in different ways.
virtual void AbortExecuteOn ()
 Set/Get the AbortExecute flag for the process object. Process objects may handle premature termination of execution in different ways.
virtual void AddInputConnection (int port, vtkAlgorithmOutput input)
 Add a connection to the given input port index. See SetInputConnection() for details on input connections. This method is the complement to RemoveInputConnection() in that it adds only the connection specified without affecting other connections. Typical usage is.
virtual void AddInputConnection (vtkAlgorithmOutput input)
 Add a connection to the given input port index. See SetInputConnection() for details on input connections. This method is the complement to RemoveInputConnection() in that it adds only the connection specified without affecting other connections. Typical usage is.
virtual double ComputePriority ()
 Returns the priority of the piece described by the current update extent. The priority is a number between 0.0 and 1.0 with 0 meaning skippable (REQUEST_DATA not needed) and 1.0 meaning important.
void ConvertTotalInputToPortConnection (int ind, ref int port, ref int conn)
 Convenience routine to convert from a linear ordering of input connections to a port/connection pair.
virtual int GetAbortExecute ()
 Set/Get the AbortExecute flag for the process object. Process objects may handle premature termination of execution in different ways.
virtual uint GetErrorCode ()
 The error code contains a possible error that occured while reading or writing the file.
vtkExecutive GetExecutive ()
 Get this algorithm's executive. If it has none, a default executive will be created.
virtual vtkInformation GetInformation ()
 Set/Get the information object associated with this algorithm.
vtkInformation GetInputArrayInformation (int idx)
 Get the info object for the specified input array to this algorithm.
vtkAlgorithmOutput GetInputConnection (int port, int index)
 Get the algorithm output port connected to an input port.
vtkDataObject GetInputDataObject (int port, int connection)
 Get the data object that will contain the algorithm input for the given port and given connection.
vtkInformation GetInputPortInformation (int port)
 Get the information object associated with an input port. There is one input port per kind of input to the algorithm. Each input port tells executives what kind of data and downstream requests this algorithm can handle for that input.
int GetNumberOfInputConnections (int port)
 Get the number of inputs currently connected to a port.
int GetNumberOfInputPorts ()
 Get the number of input ports used by the algorithm.
int GetNumberOfOutputPorts ()
 Get the number of output ports provided by the algorithm.
vtkDataObject GetOutputDataObject (int port)
 Get the data object that will contain the algorithm output for the given port.
vtkAlgorithmOutput GetOutputPort (int index)
 Get a proxy object corresponding to the given output port of this algorithm. The proxy object can be passed to another algorithm's SetInputConnection(), AddInputConnection(), and RemoveInputConnection() methods to modify pipeline connectivity.
vtkAlgorithmOutput GetOutputPort ()
 Get a proxy object corresponding to the given output port of this algorithm. The proxy object can be passed to another algorithm's SetInputConnection(), AddInputConnection(), and RemoveInputConnection() methods to modify pipeline connectivity.
vtkInformation GetOutputPortInformation (int port)
 Get the information object associated with an output port. There is one output port per output from the algorithm. Each output port tells executives what kind of upstream requests this algorithm can handle for that output.
virtual double GetProgress ()
 Set/Get the execution progress of a process object.
virtual double GetProgressMaxValue ()
 Set/Get the execution progress of a process object.
virtual double GetProgressMinValue ()
 Set/Get the execution progress of a process object.
virtual string GetProgressText ()
 Set the current text message associated with the progress state. This may be used by a calling process/GUI. Note: Because SetProgressText() is called from inside RequestData() it does not modify the algorithm object. Algorithms are not allowed to modify themselves from inside RequestData().
virtual int GetReleaseDataFlag ()
 Turn release data flag on or off for all output ports.
int GetTotalNumberOfInputConnections ()
 Get the total number of inputs for this algorithm.
int HasExecutive ()
 Check whether this algorithm has an assigned executive. This will NOT create a default executive.
virtual int ModifyRequest (vtkInformation request, int when)
 This method gives the algorithm a chance to modify the contents of a request before or after (specified in the when argument) it is forwarded. The default implementation is empty. Returns 1 on success, 0 on failure. When can be either vtkExecutive::BeforeForward or vtkExecutive::AfterForward.
int ProcessRequest (vtkInformation request, vtkCollection inInfo, vtkInformationVector outInfo)
 Version of ProcessRequest() that is wrapped. This converts the collection to an array and calls the other version.
void ReleaseDataFlagOff ()
 Turn release data flag on or off for all output ports.
void ReleaseDataFlagOn ()
 Turn release data flag on or off for all output ports.
void RemoveAllInputs ()
 Remove all the input data.
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput input)
 Remove a connection from the given input port index. See SetInputConnection() for details on input connection. This method is the complement to AddInputConnection() in that it removes only the connection specified without affecting other connections. Typical usage is.
virtual void SetAbortExecute (int _arg)
 Set/Get the AbortExecute flag for the process object. Process objects may handle premature termination of execution in different ways.
virtual void SetExecutive (vtkExecutive executive)
 Set this algorithm's executive. This algorithm is removed from any executive to which it has previously been assigned and then assigned to the given executive.
virtual void SetInformation (vtkInformation arg0)
 Set/Get the information object associated with this algorithm.
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, string name)
 Set the input data arrays that this algorithm will process. Specifically the idx array that this algorithm will process (starting from 0) is the array on port, connection with the specified association and name or attribute type (such as SCALARS). The fieldAssociation refers to which field in the data object the array is stored. See vtkDataObject::FieldAssociations for detail.
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
 Set the input data arrays that this algorithm will process. Specifically the idx array that this algorithm will process (starting from 0) is the array on port, connection with the specified association and name or attribute type (such as SCALARS). The fieldAssociation refers to which field in the data object the array is stored. See vtkDataObject::FieldAssociations for detail.
virtual void SetInputArrayToProcess (int idx, vtkInformation info)
 Set the input data arrays that this algorithm will process. Specifically the idx array that this algorithm will process (starting from 0) is the array on port, connection with the specified association and name or attribute type (such as SCALARS). The fieldAssociation refers to which field in the data object the array is stored. See vtkDataObject::FieldAssociations for detail.
virtual void SetInputArrayToProcess (int idx, int port, int connection, string fieldAssociation, string attributeTypeorName)
 String based versions of SetInputArrayToProcess(). Because fieldAssociation and fieldAttributeType are enums, they cannot be easily accessed from scripting language. These methods provides an easy and safe way of passing association and attribute type information. Field association is one of the following:
virtual void SetInputConnection (int port, vtkAlgorithmOutput input)
 Set the connection for the given input port index. Each input port of a filter has a specific purpose. A port may have zero or more connections and the required number is specified by each filter. Setting the connection with this method removes all other connections from the port. To add more than one connection use AddInputConnection().
virtual void SetInputConnection (vtkAlgorithmOutput input)
 Set the connection for the given input port index. Each input port of a filter has a specific purpose. A port may have zero or more connections and the required number is specified by each filter. Setting the connection with this method removes all other connections from the port. To add more than one connection use AddInputConnection().
virtual void SetProgress (double _arg)
 Set/Get the execution progress of a process object.
void SetProgressText (string ptext)
 Set the current text message associated with the progress state. This may be used by a calling process/GUI. Note: Because SetProgressText() is called from inside RequestData() it does not modify the algorithm object. Algorithms are not allowed to modify themselves from inside RequestData().
virtual void SetReleaseDataFlag (int arg0)
 Turn release data flag on or off for all output ports.
virtual void Update ()
 Bring this algorithm's outputs up-to-date.
int UpdateExtentIsEmpty (vtkDataObject output)
 This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0. The source uses this call to determine whether to call Execute.
int UpdateExtentIsEmpty (vtkInformation pinfo, int extentType)
 This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0. The source uses this call to determine whether to call Execute.
virtual void UpdateInformation ()
 Backward compatibility method to invoke UpdateInformation on executive.
void UpdateProgress (double amount)
 Update the progress of the process object. If a ProgressMethod exists, executes it. Then set the Progress ivar to amount. The parameter amount should range between (0,1).
virtual void UpdateWholeExtent ()
 Bring this algorithm's outputs up-to-date.
- 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 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 vtkParticleReader New ()
 *Undocumented Block
static new int IsTypeOf (string type)
 *Undocumented Block
static new vtkParticleReader SafeDownCast (vtkObjectBase o)
 *Undocumented Block

Public Attributes

new const string MRFullTypeName = "Kitware.VTK.vtkParticleReader"
 Automatically generated type registration mechanics.
- Public Attributes inherited from Kitware.VTK.vtkPolyDataAlgorithm
- Public Attributes inherited from Kitware.VTK.vtkAlgorithm
- 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 = "17vtkParticleReader"
 Automatically generated type registration mechanics.
- Static Public Attributes inherited from Kitware.VTK.vtkPolyDataAlgorithm
- Static Public Attributes inherited from Kitware.VTK.vtkAlgorithm
- 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 vtkParticleReader ()
 Automatically generated type registration mechanics.

Detailed Description

vtkParticleReader - Read ASCII or binary particle data and (optionally) one scalar value associated with each particle.

Description vtkParticleReader reads either a binary or a text file of particles. Each particle can have associated with it an optional scalar value. So the format is: x, y, z, scalar (all floats or doubles). The text file can consist of a comma delimited set of values. In most cases vtkParticleReader can automatically determine whether the file is text or binary. The data can be either float or double. Progress updates are provided. With respect to binary files, random access into the file to read pieces is supported.


Constructor & Destructor Documentation

static Kitware.VTK.vtkParticleReader.vtkParticleReader ( )
staticprivate

Automatically generated type registration mechanics.

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

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

Kitware.VTK.vtkParticleReader.vtkParticleReader ( )

*Undocumented Block


Member Function Documentation

override void Kitware.VTK.vtkParticleReader.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.vtkPolyDataAlgorithm.

int Kitware.VTK.vtkParticleReader.GetDataByteOrder ( )

These methods should be used instead of the SwapBytes methods. They indicate the byte ordering of the file you are trying to read in. These methods will then either swap or not swap the bytes depending on the byte ordering of the machine it is being run on. For example, reading in a BigEndian file on a BigEndian machine will result in no swapping. Trying to read the same file on a LittleEndian machine will result in swapping. As a quick note most UNIX machines are BigEndian while PC's and VAX tend to be LittleEndian. So if the file you are reading in was generated on a VAX or PC, SetDataByteOrderToLittleEndian otherwise SetDataByteOrderToBigEndian. Not used when reading text files.

string Kitware.VTK.vtkParticleReader.GetDataByteOrderAsString ( )

These methods should be used instead of the SwapBytes methods. They indicate the byte ordering of the file you are trying to read in. These methods will then either swap or not swap the bytes depending on the byte ordering of the machine it is being run on. For example, reading in a BigEndian file on a BigEndian machine will result in no swapping. Trying to read the same file on a LittleEndian machine will result in swapping. As a quick note most UNIX machines are BigEndian while PC's and VAX tend to be LittleEndian. So if the file you are reading in was generated on a VAX or PC, SetDataByteOrderToLittleEndian otherwise SetDataByteOrderToBigEndian. Not used when reading text files.

virtual int Kitware.VTK.vtkParticleReader.GetDataType ( )
virtual

Get/Set the data type. The options are:

  • VTK_FLOAT (default) single precision floating point.
  • VTK_DOUBLE double precision floating point.
virtual int Kitware.VTK.vtkParticleReader.GetDataTypeMaxValue ( )
virtual

Get/Set the data type. The options are:

  • VTK_FLOAT (default) single precision floating point.
  • VTK_DOUBLE double precision floating point.
virtual int Kitware.VTK.vtkParticleReader.GetDataTypeMinValue ( )
virtual

Get/Set the data type. The options are:

  • VTK_FLOAT (default) single precision floating point.
  • VTK_DOUBLE double precision floating point.
virtual string Kitware.VTK.vtkParticleReader.GetFileName ( )
virtual

Specify file name.

virtual int Kitware.VTK.vtkParticleReader.GetFileType ( )
virtual

Get/Set the file type. The options are:

  • FILE_TYPE_IS_UNKNOWN (default) the class will attempt to determine the file type. If this fails then you should set the file type yourself.
  • FILE_TYPE_IS_TEXT the file type is text.
  • FILE_TYPE_IS_BINARY the file type is binary.
virtual int Kitware.VTK.vtkParticleReader.GetFileTypeMaxValue ( )
virtual

Get/Set the file type. The options are:

  • FILE_TYPE_IS_UNKNOWN (default) the class will attempt to determine the file type. If this fails then you should set the file type yourself.
  • FILE_TYPE_IS_TEXT the file type is text.
  • FILE_TYPE_IS_BINARY the file type is binary.
virtual int Kitware.VTK.vtkParticleReader.GetFileTypeMinValue ( )
virtual

Get/Set the file type. The options are:

  • FILE_TYPE_IS_UNKNOWN (default) the class will attempt to determine the file type. If this fails then you should set the file type yourself.
  • FILE_TYPE_IS_TEXT the file type is text.
  • FILE_TYPE_IS_BINARY the file type is binary.
virtual int Kitware.VTK.vtkParticleReader.GetHasScalar ( )
virtual

Default: 1. If 1 then each particle has a value associated with it.

int Kitware.VTK.vtkParticleReader.GetSwapBytes ( )

Set/Get the byte swapping to explicitly swap the bytes of a file. Not used when reading text files.

virtual void Kitware.VTK.vtkParticleReader.HasScalarOff ( )
virtual

Default: 1. If 1 then each particle has a value associated with it.

virtual void Kitware.VTK.vtkParticleReader.HasScalarOn ( )
virtual

Default: 1. If 1 then each particle has a value associated with it.

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

*Undocumented Block

Reimplemented from Kitware.VTK.vtkPolyDataAlgorithm.

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

*Undocumented Block

Reimplemented from Kitware.VTK.vtkPolyDataAlgorithm.

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

*Undocumented Block

Reimplemented from Kitware.VTK.vtkPolyDataAlgorithm.

new vtkParticleReader Kitware.VTK.vtkParticleReader.NewInstance ( )

*Undocumented Block

Reimplemented from Kitware.VTK.vtkPolyDataAlgorithm.

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

*Undocumented Block

Reimplemented from Kitware.VTK.vtkPolyDataAlgorithm.

Here is the call graph for this function:

void Kitware.VTK.vtkParticleReader.SetDataByteOrder ( int  arg0)

These methods should be used instead of the SwapBytes methods. They indicate the byte ordering of the file you are trying to read in. These methods will then either swap or not swap the bytes depending on the byte ordering of the machine it is being run on. For example, reading in a BigEndian file on a BigEndian machine will result in no swapping. Trying to read the same file on a LittleEndian machine will result in swapping. As a quick note most UNIX machines are BigEndian while PC's and VAX tend to be LittleEndian. So if the file you are reading in was generated on a VAX or PC, SetDataByteOrderToLittleEndian otherwise SetDataByteOrderToBigEndian. Not used when reading text files.

void Kitware.VTK.vtkParticleReader.SetDataByteOrderToBigEndian ( )

These methods should be used instead of the SwapBytes methods. They indicate the byte ordering of the file you are trying to read in. These methods will then either swap or not swap the bytes depending on the byte ordering of the machine it is being run on. For example, reading in a BigEndian file on a BigEndian machine will result in no swapping. Trying to read the same file on a LittleEndian machine will result in swapping. As a quick note most UNIX machines are BigEndian while PC's and VAX tend to be LittleEndian. So if the file you are reading in was generated on a VAX or PC, SetDataByteOrderToLittleEndian otherwise SetDataByteOrderToBigEndian. Not used when reading text files.

void Kitware.VTK.vtkParticleReader.SetDataByteOrderToLittleEndian ( )

These methods should be used instead of the SwapBytes methods. They indicate the byte ordering of the file you are trying to read in. These methods will then either swap or not swap the bytes depending on the byte ordering of the machine it is being run on. For example, reading in a BigEndian file on a BigEndian machine will result in no swapping. Trying to read the same file on a LittleEndian machine will result in swapping. As a quick note most UNIX machines are BigEndian while PC's and VAX tend to be LittleEndian. So if the file you are reading in was generated on a VAX or PC, SetDataByteOrderToLittleEndian otherwise SetDataByteOrderToBigEndian. Not used when reading text files.

virtual void Kitware.VTK.vtkParticleReader.SetDataType ( int  _arg)
virtual

Get/Set the data type. The options are:

  • VTK_FLOAT (default) single precision floating point.
  • VTK_DOUBLE double precision floating point.
void Kitware.VTK.vtkParticleReader.SetDataTypeToDouble ( )

Get/Set the data type. The options are:

  • VTK_FLOAT (default) single precision floating point.
  • VTK_DOUBLE double precision floating point.
void Kitware.VTK.vtkParticleReader.SetDataTypeToFloat ( )

Get/Set the data type. The options are:

  • VTK_FLOAT (default) single precision floating point.
  • VTK_DOUBLE double precision floating point.
virtual void Kitware.VTK.vtkParticleReader.SetFileName ( string  _arg)
virtual

Specify file name.

virtual void Kitware.VTK.vtkParticleReader.SetFileType ( int  _arg)
virtual

Get/Set the file type. The options are:

  • FILE_TYPE_IS_UNKNOWN (default) the class will attempt to determine the file type. If this fails then you should set the file type yourself.
  • FILE_TYPE_IS_TEXT the file type is text.
  • FILE_TYPE_IS_BINARY the file type is binary.
void Kitware.VTK.vtkParticleReader.SetFileTypeToBinary ( )

Get/Set the file type. The options are:

  • FILE_TYPE_IS_UNKNOWN (default) the class will attempt to determine the file type. If this fails then you should set the file type yourself.
  • FILE_TYPE_IS_TEXT the file type is text.
  • FILE_TYPE_IS_BINARY the file type is binary.
void Kitware.VTK.vtkParticleReader.SetFileTypeToText ( )

Get/Set the file type. The options are:

  • FILE_TYPE_IS_UNKNOWN (default) the class will attempt to determine the file type. If this fails then you should set the file type yourself.
  • FILE_TYPE_IS_TEXT the file type is text.
  • FILE_TYPE_IS_BINARY the file type is binary.
void Kitware.VTK.vtkParticleReader.SetFileTypeToUnknown ( )

Get/Set the file type. The options are:

  • FILE_TYPE_IS_UNKNOWN (default) the class will attempt to determine the file type. If this fails then you should set the file type yourself.
  • FILE_TYPE_IS_TEXT the file type is text.
  • FILE_TYPE_IS_BINARY the file type is binary.
virtual void Kitware.VTK.vtkParticleReader.SetHasScalar ( int  _arg)
virtual

Default: 1. If 1 then each particle has a value associated with it.

virtual void Kitware.VTK.vtkParticleReader.SetSwapBytes ( int  _arg)
virtual

Set/Get the byte swapping to explicitly swap the bytes of a file. Not used when reading text files.

virtual void Kitware.VTK.vtkParticleReader.SwapBytesOff ( )
virtual

Set/Get the byte swapping to explicitly swap the bytes of a file. Not used when reading text files.

virtual void Kitware.VTK.vtkParticleReader.SwapBytesOn ( )
virtual

Set/Get the byte swapping to explicitly swap the bytes of a file. Not used when reading text files.


Member Data Documentation

new readonly string Kitware.VTK.vtkParticleReader.MRClassNameKey = "17vtkParticleReader"
static

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkPolyDataAlgorithm.

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

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkPolyDataAlgorithm.


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