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

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.

Static Public Attributes

static new readonly string MRClassNameKey = "17vtkParticleReader"
 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 vtkParticleReader_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtkParticleReader_GetDataByteOrder_01 (HandleRef pThis)
static internal IntPtr vtkParticleReader_GetDataByteOrderAsString_02 (HandleRef pThis)
static internal int vtkParticleReader_GetDataType_03 (HandleRef pThis)
static internal int vtkParticleReader_GetDataTypeMaxValue_04 (HandleRef pThis)
static internal int vtkParticleReader_GetDataTypeMinValue_05 (HandleRef pThis)
static internal IntPtr vtkParticleReader_GetFileName_06 (HandleRef pThis)
static internal int vtkParticleReader_GetFileType_07 (HandleRef pThis)
static internal int vtkParticleReader_GetFileTypeMaxValue_08 (HandleRef pThis)
static internal int vtkParticleReader_GetFileTypeMinValue_09 (HandleRef pThis)
static internal int vtkParticleReader_GetHasScalar_10 (HandleRef pThis)
static internal int vtkParticleReader_GetSwapBytes_11 (HandleRef pThis)
static internal void vtkParticleReader_HasScalarOff_12 (HandleRef pThis)
static internal void vtkParticleReader_HasScalarOn_13 (HandleRef pThis)
static internal int vtkParticleReader_IsA_14 (HandleRef pThis, string type)
static internal int vtkParticleReader_IsTypeOf_15 (string type)
static internal IntPtr vtkParticleReader_NewInstance_17 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkParticleReader_SafeDownCast_18 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkParticleReader_SetDataByteOrder_19 (HandleRef pThis, int arg0)
static internal void vtkParticleReader_SetDataByteOrderToBigEndian_20 (HandleRef pThis)
static internal void vtkParticleReader_SetDataByteOrderToLittleEndian_21 (HandleRef pThis)
static internal void vtkParticleReader_SetDataType_22 (HandleRef pThis, int _arg)
static internal void vtkParticleReader_SetDataTypeToDouble_23 (HandleRef pThis)
static internal void vtkParticleReader_SetDataTypeToFloat_24 (HandleRef pThis)
static internal void vtkParticleReader_SetFileName_25 (HandleRef pThis, string _arg)
static internal void vtkParticleReader_SetFileType_26 (HandleRef pThis, int _arg)
static internal void vtkParticleReader_SetFileTypeToBinary_27 (HandleRef pThis)
static internal void vtkParticleReader_SetFileTypeToText_28 (HandleRef pThis)
static internal void vtkParticleReader_SetFileTypeToUnknown_29 (HandleRef pThis)
static internal void vtkParticleReader_SetHasScalar_30 (HandleRef pThis, int _arg)
static internal void vtkParticleReader_SetSwapBytes_31 (HandleRef pThis, int _arg)
static internal void vtkParticleReader_SwapBytesOff_32 (HandleRef pThis)
static internal void vtkParticleReader_SwapBytesOn_33 (HandleRef pThis)

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

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.

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.

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.

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.

Get/Set the data type. The options are:

  • VTK_FLOAT (default) single precision floating point.
  • VTK_DOUBLE double precision floating point.

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.

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.

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.

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.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkPolyDataAlgorithm.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkPolyDataAlgorithm.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkPolyDataAlgorithm.

Here is the call graph for this function:

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.

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.

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.

Get/Set the data type. The options are:

  • VTK_FLOAT (default) single precision floating point.
  • VTK_DOUBLE double precision floating point.

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.

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.

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.

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.

static internal int Kitware.VTK.vtkParticleReader.vtkParticleReader_GetDataByteOrder_01 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkParticleReader.vtkParticleReader_GetDataByteOrderAsString_02 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkParticleReader.vtkParticleReader_GetDataType_03 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkParticleReader.vtkParticleReader_GetDataTypeMaxValue_04 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkParticleReader.vtkParticleReader_GetDataTypeMinValue_05 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkParticleReader.vtkParticleReader_GetFileName_06 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkParticleReader.vtkParticleReader_GetFileType_07 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkParticleReader.vtkParticleReader_GetFileTypeMaxValue_08 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkParticleReader.vtkParticleReader_GetFileTypeMinValue_09 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkParticleReader.vtkParticleReader_GetHasScalar_10 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkParticleReader.vtkParticleReader_GetSwapBytes_11 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkParticleReader.vtkParticleReader_HasScalarOff_12 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkParticleReader.vtkParticleReader_HasScalarOn_13 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkParticleReader.vtkParticleReader_IsA_14 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkParticleReader.vtkParticleReader_IsTypeOf_15 ( string  type) [private]
static internal IntPtr Kitware.VTK.vtkParticleReader.vtkParticleReader_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkParticleReader.vtkParticleReader_NewInstance_17 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkParticleReader.vtkParticleReader_SafeDownCast_18 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkParticleReader.vtkParticleReader_SetDataByteOrder_19 ( HandleRef  pThis,
int  arg0 
) [private]
static internal void Kitware.VTK.vtkParticleReader.vtkParticleReader_SetDataByteOrderToBigEndian_20 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkParticleReader.vtkParticleReader_SetDataByteOrderToLittleEndian_21 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkParticleReader.vtkParticleReader_SetDataType_22 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkParticleReader.vtkParticleReader_SetDataTypeToDouble_23 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkParticleReader.vtkParticleReader_SetDataTypeToFloat_24 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkParticleReader.vtkParticleReader_SetFileName_25 ( HandleRef  pThis,
string  _arg 
) [private]
static internal void Kitware.VTK.vtkParticleReader.vtkParticleReader_SetFileType_26 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkParticleReader.vtkParticleReader_SetFileTypeToBinary_27 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkParticleReader.vtkParticleReader_SetFileTypeToText_28 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkParticleReader.vtkParticleReader_SetFileTypeToUnknown_29 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkParticleReader.vtkParticleReader_SetHasScalar_30 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkParticleReader.vtkParticleReader_SetSwapBytes_31 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkParticleReader.vtkParticleReader_SwapBytesOff_32 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkParticleReader.vtkParticleReader_SwapBytesOn_33 ( HandleRef  pThis) [private]

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: