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

vtkBMPReader - read Windows BMP files More...

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

List of all members.

Public Member Functions

 vtkBMPReader (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkBMPReader ()
 Undocumented Block.
virtual void Allow8BitBMPOff ()
 If this flag is set and the BMP reader encounters an 8bit file, the data will be kept as unsigned chars and a lookuptable will be exported.
virtual void Allow8BitBMPOn ()
 If this flag is set and the BMP reader encounters an 8bit file, the data will be kept as unsigned chars and a lookuptable will be exported.
override int CanReadFile (string fname)
 Is the given file a BMP file?
virtual int GetAllow8BitBMP ()
 If this flag is set and the BMP reader encounters an 8bit file, the data will be kept as unsigned chars and a lookuptable will be exported.
virtual IntPtr GetColors ()
 If this flag is set and the BMP reader encounters an 8bit file, the data will be kept as unsigned chars and a lookuptable will be exported.
virtual int GetDepth ()
 Returns the depth of the BMP, either 8 or 24.
override string GetDescriptiveName ()
 Return a descriptive name for the file format that might be useful in a GUI.
override string GetFileExtensions ()
 Get the file extensions for this format. Returns a string with a space separated list of extensions in the format .extension.
virtual vtkLookupTable GetLookupTable ()
 If this flag is set and the BMP reader encounters an 8bit file, the data will be kept as unsigned chars and a lookuptable will be exported.
override int IsA (string type)
 Undocumented Block.
new vtkBMPReader NewInstance ()
 Undocumented Block.
virtual void SetAllow8BitBMP (int _arg)
 If this flag is set and the BMP reader encounters an 8bit file, the data will be kept as unsigned chars and a lookuptable will be exported.

Static Public Member Functions

static new vtkBMPReader New ()
 Undocumented Block.
static new int IsTypeOf (string type)
 Undocumented Block.
static new vtkBMPReader SafeDownCast (vtkObjectBase o)
 Undocumented Block.

Public Attributes

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

Static Public Attributes

static new readonly string MRClassNameKey = "12vtkBMPReader"
 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 vtkBMPReader_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkBMPReader_Allow8BitBMPOff_01 (HandleRef pThis)
static internal void vtkBMPReader_Allow8BitBMPOn_02 (HandleRef pThis)
static internal int vtkBMPReader_CanReadFile_03 (HandleRef pThis, string fname)
static internal int vtkBMPReader_GetAllow8BitBMP_04 (HandleRef pThis)
static internal IntPtr vtkBMPReader_GetColors_05 (HandleRef pThis)
static internal int vtkBMPReader_GetDepth_06 (HandleRef pThis)
static internal IntPtr vtkBMPReader_GetDescriptiveName_07 (HandleRef pThis)
static internal IntPtr vtkBMPReader_GetFileExtensions_08 (HandleRef pThis)
static internal IntPtr vtkBMPReader_GetLookupTable_09 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtkBMPReader_IsA_10 (HandleRef pThis, string type)
static internal int vtkBMPReader_IsTypeOf_11 (string type)
static internal IntPtr vtkBMPReader_NewInstance_13 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkBMPReader_SafeDownCast_14 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkBMPReader_SetAllow8BitBMP_15 (HandleRef pThis, int _arg)

Static Private Member Functions

static vtkBMPReader ()
 Automatically generated type registration mechanics.

Detailed Description

vtkBMPReader - read Windows BMP files

Description vtkBMPReader is a source object that reads Windows BMP files. This includes indexed and 24bit bitmaps Usually, all BMPs are converted to 24bit RGB, but BMPs may be output as 8bit images with a LookupTable if the Allow8BitBMP flag is set.

BMPReader creates structured point datasets. The dimension of the dataset depends upon the number of files read. Reading a single file results in a 2D image, while reading more than one file results in a 3D volume.

To read a volume, files must be of the form "FileName.<number>" (e.g., foo.bmp.0, foo.bmp.1, ...). You must also specify the image range. This range specifies the beginning and ending files to read (range can be any pair of non-negative numbers).

The default behavior is to read a single file. In this case, the form of the file is simply "FileName" (e.g., foo.bmp).


Constructor & Destructor Documentation

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

Automatically generated type registration mechanics.

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

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

Undocumented Block.


Member Function Documentation

virtual void Kitware.VTK.vtkBMPReader.Allow8BitBMPOff ( ) [virtual]

If this flag is set and the BMP reader encounters an 8bit file, the data will be kept as unsigned chars and a lookuptable will be exported.

virtual void Kitware.VTK.vtkBMPReader.Allow8BitBMPOn ( ) [virtual]

If this flag is set and the BMP reader encounters an 8bit file, the data will be kept as unsigned chars and a lookuptable will be exported.

override int Kitware.VTK.vtkBMPReader.CanReadFile ( string  fname) [virtual]

Is the given file a BMP file?

Reimplemented from Kitware.VTK.vtkImageReader2.

override void Kitware.VTK.vtkBMPReader.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.vtkImageReader.

virtual int Kitware.VTK.vtkBMPReader.GetAllow8BitBMP ( ) [virtual]

If this flag is set and the BMP reader encounters an 8bit file, the data will be kept as unsigned chars and a lookuptable will be exported.

virtual IntPtr Kitware.VTK.vtkBMPReader.GetColors ( ) [virtual]

If this flag is set and the BMP reader encounters an 8bit file, the data will be kept as unsigned chars and a lookuptable will be exported.

virtual int Kitware.VTK.vtkBMPReader.GetDepth ( ) [virtual]

Returns the depth of the BMP, either 8 or 24.

override string Kitware.VTK.vtkBMPReader.GetDescriptiveName ( ) [virtual]

Return a descriptive name for the file format that might be useful in a GUI.

Reimplemented from Kitware.VTK.vtkImageReader2.

override string Kitware.VTK.vtkBMPReader.GetFileExtensions ( ) [virtual]

Get the file extensions for this format. Returns a string with a space separated list of extensions in the format .extension.

Reimplemented from Kitware.VTK.vtkImageReader2.

If this flag is set and the BMP reader encounters an 8bit file, the data will be kept as unsigned chars and a lookuptable will be exported.

Here is the call graph for this function:

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

Undocumented Block.

Reimplemented from Kitware.VTK.vtkImageReader.

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

Undocumented Block.

Reimplemented from Kitware.VTK.vtkImageReader.

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

Undocumented Block.

Reimplemented from Kitware.VTK.vtkImageReader.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkImageReader.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkImageReader.

Here is the call graph for this function:

virtual void Kitware.VTK.vtkBMPReader.SetAllow8BitBMP ( int  _arg) [virtual]

If this flag is set and the BMP reader encounters an 8bit file, the data will be kept as unsigned chars and a lookuptable will be exported.

static internal void Kitware.VTK.vtkBMPReader.vtkBMPReader_Allow8BitBMPOff_01 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkBMPReader.vtkBMPReader_Allow8BitBMPOn_02 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkBMPReader.vtkBMPReader_CanReadFile_03 ( HandleRef  pThis,
string  fname 
) [private]
static internal int Kitware.VTK.vtkBMPReader.vtkBMPReader_GetAllow8BitBMP_04 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkBMPReader.vtkBMPReader_GetColors_05 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkBMPReader.vtkBMPReader_GetDepth_06 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkBMPReader.vtkBMPReader_GetDescriptiveName_07 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkBMPReader.vtkBMPReader_GetFileExtensions_08 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkBMPReader.vtkBMPReader_GetLookupTable_09 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal int Kitware.VTK.vtkBMPReader.vtkBMPReader_IsA_10 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkBMPReader.vtkBMPReader_IsTypeOf_11 ( string  type) [private]
static internal IntPtr Kitware.VTK.vtkBMPReader.vtkBMPReader_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkBMPReader.vtkBMPReader_NewInstance_13 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkBMPReader.vtkBMPReader_SafeDownCast_14 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkBMPReader.vtkBMPReader_SetAllow8BitBMP_15 ( HandleRef  pThis,
int  _arg 
) [private]

Member Data Documentation

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

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkImageReader.

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

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkImageReader.


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