ActiViz .NET  5.10.1
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Static Private Member Functions | List of all members
Kitware.VTK.vtkDataTransferHelper Class Reference

vtkDataTransferHelper - is a helper class that aids in transferring data between CPU memory and GPU memory. More...

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

Public Member Functions

 vtkDataTransferHelper (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly. More...
 
 vtkDataTransferHelper ()
 Undocumented Block More...
 
bool Download ()
 old comment: Download Extent from GPU data buffer to CPU. GPU data size must exactly match Extent. CPU data buffer will be resized to match WholeExtent in which only the Extent will be filled with the GPU data. new comment: Download GPUExtent from GPU texture to CPU vtkDataArray. If Array is not provided, it will be created with the size of CPUExtent. But only the tuples covered by GPUExtent will be download. In this case, if GPUExtent does not cover all GPUExtent, some of the vtkDataArray will be uninitialized. Reminder: A=>B <=> !A||B More...
 
bool DownloadAsync1 ()
 Splits the download in two operations More...
 
bool DownloadAsync2 ()
 Splits the download in two operations More...
 
virtual vtkDataArray GetArray ()
 Get/Set the CPU data buffer. Initial value is 0. More...
 
virtual int[] GetCPUExtent ()
 Set the CPU data extent. The extent matches the vtkDataArray size. If the vtkDataArray comes from an vtkImageData and it is part of the point data, it is usually the vtkImageData extent. It can be on cell data too, but in this case it does not match the vtkImageData extent. If the vtkDataArray comes from a vtkDataSet, just set it to a one-dimenstional extent equal to the number of tuples. Initial value is (0,0,0,0,0,0), a valid one tuple array. More...
 
virtual void GetCPUExtent (ref int _arg1, ref int _arg2, ref int _arg3, ref int _arg4, ref int _arg5, ref int _arg6)
 Set the CPU data extent. The extent matches the vtkDataArray size. If the vtkDataArray comes from an vtkImageData and it is part of the point data, it is usually the vtkImageData extent. It can be on cell data too, but in this case it does not match the vtkImageData extent. If the vtkDataArray comes from a vtkDataSet, just set it to a one-dimenstional extent equal to the number of tuples. Initial value is (0,0,0,0,0,0), a valid one tuple array. More...
 
virtual void GetCPUExtent (IntPtr _arg)
 Set the CPU data extent. The extent matches the vtkDataArray size. If the vtkDataArray comes from an vtkImageData and it is part of the point data, it is usually the vtkImageData extent. It can be on cell data too, but in this case it does not match the vtkImageData extent. If the vtkDataArray comes from a vtkDataSet, just set it to a one-dimenstional extent equal to the number of tuples. Initial value is (0,0,0,0,0,0), a valid one tuple array. More...
 
bool GetCPUExtentIsValid ()
 Tells if CPUExtent is valid. True if min extent<=max extent. More...
 
vtkRenderWindow GetContext ()
 Get/Set the context. Context must be a vtkOpenGLRenderWindow. This does not increase the reference count of the context to avoid reference loops. SetContext() may raise an error is the OpenGL context does not support the required OpenGL extensions. More...
 
bool GetExtentIsValid (IntPtr extent)
 Tells if the given extent (6 int) is valid. True if min extent<=max extent. More...
 
virtual int[] GetGPUExtent ()
 Set the GPU data extent. This is the sub-extent to copy from or to the GPU. This extent matches the size of the data to transfer. GPUExtent and TextureExtent don't have to match (GPUExtent can be 1D whereas TextureExtent is 2D) but the number of elements have to match. Initial value is (0,0,0,0,0,0), a valid one tuple array. More...
 
virtual void GetGPUExtent (ref int _arg1, ref int _arg2, ref int _arg3, ref int _arg4, ref int _arg5, ref int _arg6)
 Set the GPU data extent. This is the sub-extent to copy from or to the GPU. This extent matches the size of the data to transfer. GPUExtent and TextureExtent don't have to match (GPUExtent can be 1D whereas TextureExtent is 2D) but the number of elements have to match. Initial value is (0,0,0,0,0,0), a valid one tuple array. More...
 
virtual void GetGPUExtent (IntPtr _arg)
 Set the GPU data extent. This is the sub-extent to copy from or to the GPU. This extent matches the size of the data to transfer. GPUExtent and TextureExtent don't have to match (GPUExtent can be 1D whereas TextureExtent is 2D) but the number of elements have to match. Initial value is (0,0,0,0,0,0), a valid one tuple array. More...
 
bool GetGPUExtentIsValid ()
 Tells if GPUExtent is valid. True if min extent<=max extent. More...
 
virtual int GetMinTextureDimension ()
 Define the minimal dimension of the texture regardless of the dimensions of the TextureExtent. Initial value is 1. A texture extent can have a given dimension 0D (one value), 1D, 2D or 3D. By default 0D and 1D are translated into a 1D texture, 2D is translated into a 2D texture, 3D is translated into a 3D texture. To make life easier when writting GLSL code and use only one type of sampler (ex: sampler2d), the default behavior can be changed by forcing a type of texture with this ivar. 1: default behavior. Initial value. 2: force 0D and 1D to be in a 2D texture 3: force 0D, 1D and 2D texture to be in a 3D texture. More...
 
bool GetShaderSupportsTextureInt ()
 Splits the download in two operations More...
 
virtual vtkTextureObject GetTexture ()
 Get/Set the GPU data buffer. Initial value is 0. More...
 
virtual int[] GetTextureExtent ()
 Set the texture data extent. This is the extent of the texture image that will receive the data. This extent matches the size of the data to transfer. If it is set to an invalid extent, GPUExtent is used. See more comment on GPUExtent. Initial value is an invalid extent. More...
 
virtual void GetTextureExtent (ref int _arg1, ref int _arg2, ref int _arg3, ref int _arg4, ref int _arg5, ref int _arg6)
 Set the texture data extent. This is the extent of the texture image that will receive the data. This extent matches the size of the data to transfer. If it is set to an invalid extent, GPUExtent is used. See more comment on GPUExtent. Initial value is an invalid extent. More...
 
virtual void GetTextureExtent (IntPtr _arg)
 Set the texture data extent. This is the extent of the texture image that will receive the data. This extent matches the size of the data to transfer. If it is set to an invalid extent, GPUExtent is used. See more comment on GPUExtent. Initial value is an invalid extent. More...
 
bool GetTextureExtentIsValid ()
 Tells if TextureExtent is valid. True if min extent<=max extent. More...
 
override int IsA (string type)
 Undocumented Block More...
 
new vtkDataTransferHelper NewInstance ()
 Undocumented Block More...
 
void SetArray (vtkDataArray array)
 Get/Set the CPU data buffer. Initial value is 0. More...
 
virtual void SetCPUExtent (int _arg1, int _arg2, int _arg3, int _arg4, int _arg5, int _arg6)
 Set the CPU data extent. The extent matches the vtkDataArray size. If the vtkDataArray comes from an vtkImageData and it is part of the point data, it is usually the vtkImageData extent. It can be on cell data too, but in this case it does not match the vtkImageData extent. If the vtkDataArray comes from a vtkDataSet, just set it to a one-dimenstional extent equal to the number of tuples. Initial value is (0,0,0,0,0,0), a valid one tuple array. More...
 
virtual void SetCPUExtent (IntPtr _arg)
 Set the CPU data extent. The extent matches the vtkDataArray size. If the vtkDataArray comes from an vtkImageData and it is part of the point data, it is usually the vtkImageData extent. It can be on cell data too, but in this case it does not match the vtkImageData extent. If the vtkDataArray comes from a vtkDataSet, just set it to a one-dimenstional extent equal to the number of tuples. Initial value is (0,0,0,0,0,0), a valid one tuple array. More...
 
void SetContext (vtkRenderWindow context)
 Get/Set the context. Context must be a vtkOpenGLRenderWindow. This does not increase the reference count of the context to avoid reference loops. SetContext() may raise an error is the OpenGL context does not support the required OpenGL extensions. More...
 
virtual void SetGPUExtent (int _arg1, int _arg2, int _arg3, int _arg4, int _arg5, int _arg6)
 Set the GPU data extent. This is the sub-extent to copy from or to the GPU. This extent matches the size of the data to transfer. GPUExtent and TextureExtent don't have to match (GPUExtent can be 1D whereas TextureExtent is 2D) but the number of elements have to match. Initial value is (0,0,0,0,0,0), a valid one tuple array. More...
 
virtual void SetGPUExtent (IntPtr _arg)
 Set the GPU data extent. This is the sub-extent to copy from or to the GPU. This extent matches the size of the data to transfer. GPUExtent and TextureExtent don't have to match (GPUExtent can be 1D whereas TextureExtent is 2D) but the number of elements have to match. Initial value is (0,0,0,0,0,0), a valid one tuple array. More...
 
virtual void SetMinTextureDimension (int _arg)
 Define the minimal dimension of the texture regardless of the dimensions of the TextureExtent. Initial value is 1. A texture extent can have a given dimension 0D (one value), 1D, 2D or 3D. By default 0D and 1D are translated into a 1D texture, 2D is translated into a 2D texture, 3D is translated into a 3D texture. To make life easier when writting GLSL code and use only one type of sampler (ex: sampler2d), the default behavior can be changed by forcing a type of texture with this ivar. 1: default behavior. Initial value. 2: force 0D and 1D to be in a 2D texture 3: force 0D, 1D and 2D texture to be in a 3D texture. More...
 
void SetShaderSupportsTextureInt (bool value)
 Splits the download in two operations More...
 
void SetTexture (vtkTextureObject texture)
 Get/Set the GPU data buffer. Initial value is 0. More...
 
virtual void SetTextureExtent (int _arg1, int _arg2, int _arg3, int _arg4, int _arg5, int _arg6)
 Set the texture data extent. This is the extent of the texture image that will receive the data. This extent matches the size of the data to transfer. If it is set to an invalid extent, GPUExtent is used. See more comment on GPUExtent. Initial value is an invalid extent. More...
 
virtual void SetTextureExtent (IntPtr _arg)
 Set the texture data extent. This is the extent of the texture image that will receive the data. This extent matches the size of the data to transfer. If it is set to an invalid extent, GPUExtent is used. See more comment on GPUExtent. Initial value is an invalid extent. More...
 
bool Upload (int components, IntPtr componentList)
 Old comment. Upload Extent from CPU data buffer to GPU. The WholeExtent must match the Array size. New comment. Upload GPUExtent from CPU vtkDataArray to GPU texture. It is possible to send a subset of the components or to specify and order of components or both. If components=0, componentList is ignored and all components are passed, a texture cannot have more than 4 components. More...
 
- 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. More...
 
 vtkObject ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
uint AddObserver (uint arg0, vtkCommand arg1, float priority)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
uint AddObserver (string arg0, vtkCommand arg1, float priority)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
vtkCommand GetCommand (uint tag)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
byte GetDebug ()
 Get the value of the debug flag. More...
 
virtual uint GetMTime ()
 Return this object's modified time. More...
 
int HasObserver (uint arg0, vtkCommand arg1)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
int HasObserver (string arg0, vtkCommand arg1)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
int HasObserver (uint arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
int HasObserver (string arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
int InvokeEvent (uint arg0, IntPtr callData)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
int InvokeEvent (string arg0, IntPtr callData)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
int InvokeEvent (uint arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
int InvokeEvent (string arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
override int IsA (string type)
 Undocumented Block More...
 
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. More...
 
vtkObject NewInstance ()
 Undocumented Block More...
 
void RemoveAllObservers ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
void RemoveObserver (vtkCommand arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
void RemoveObserver (uint tag)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
void RemoveObservers (uint arg0, vtkCommand arg1)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
void RemoveObservers (string arg0, vtkCommand arg1)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
void RemoveObservers (uint arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
void RemoveObservers (string arg0)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
void SetDebug (byte debugFlag)
 Set the value of the debug flag. A non-zero value turns debugging on. More...
 
override string ToString ()
 Returns the result of calling vtkObject::Print as a C# string. More...
 
delegate void vtkObjectEventHandler (vtkObject sender, vtkObjectEventArgs e)
 Generic signature for all vtkObject events. More...
 
void RemoveAllHandlersForAllEvents ()
 Call RemoveAllHandlers on each non-null vtkObjectEventRelay. TODO: This method needs to get called by the generated Dispose. Make that happen... More...
 
- 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. More...
 
 vtkObjectBase ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
virtual void Register (vtkObjectBase o)
 Increase the reference count (mark as used by another object). More...
 
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. More...
 
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. More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int arg0)
 Sets the reference count. (This is very dangerous, use with care.) More...
 

Static Public Member Functions

static new vtkDataTransferHelper New ()
 Undocumented Block More...
 
static bool IsSupported (vtkRenderWindow renWin)
 Returns if the context supports the required extensions. More...
 
static new int IsTypeOf (string type)
 Undocumented Block More...
 
static new vtkDataTransferHelper SafeDownCast (vtkObjectBase o)
 Undocumented Block More...
 
- Static Public Member Functions inherited from Kitware.VTK.vtkObject
static new vtkObject New ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. It allows the debugger to break on error. More...
 
static int GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static new int IsTypeOf (string type)
 Undocumented Block More...
 
static vtkObject SafeDownCast (vtkObjectBase o)
 Undocumented Block More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
- Static Public Member Functions inherited from Kitware.VTK.vtkObjectBase
static vtkObjectBase New ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static int IsTypeOf (string name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h. More...
 

Public Attributes

new const string MRFullTypeName = "Kitware.VTK.vtkDataTransferHelper"
 Automatically generated type registration mechanics. More...
 
- Public Attributes inherited from Kitware.VTK.vtkObject
new const string MRFullTypeName = "Kitware.VTK.vtkObject"
 Automatically generated type registration mechanics. More...
 
- Public Attributes inherited from Kitware.VTK.vtkObjectBase
new const string MRFullTypeName = "Kitware.VTK.vtkObjectBase"
 Automatically generated type registration mechanics. More...
 
- 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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 

Static Public Attributes

static new readonly string MRClassNameKey = "21vtkDataTransferHelper"
 Automatically generated type registration mechanics. More...
 
- Static Public Attributes inherited from Kitware.VTK.vtkObject
static new readonly string MRClassNameKey = "9vtkObject"
 Automatically generated type registration mechanics. More...
 
- Static Public Attributes inherited from Kitware.VTK.vtkObjectBase
static new readonly string MRClassNameKey = "13vtkObjectBase"
 Automatically generated type registration mechanics. More...
 

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. More...
 
- Protected Member Functions inherited from Kitware.VTK.vtkObject
override void Dispose (bool disposing)
 Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly. More...
 
- Protected Member Functions inherited from Kitware.VTK.vtkObjectBase
override void Dispose (bool disposing)
 Decrease the reference count (release by another object). This has the same effect as invoking Delete() (i.e., it reduces the reference count by 1). More...
 
- Protected Member Functions inherited from Kitware.VTK.WrappedObject
 WrappedObject (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Constructor expected by the mummy Runtime. More...
 

Static Private Member Functions

static vtkDataTransferHelper ()
 Automatically generated type registration mechanics. More...
 

Additional Inherited Members

- Properties inherited from Kitware.VTK.vtkObject
Kitware.VTK.vtkObject.vtkObjectEventHandler AbortCheckEvt
 The AbortCheckEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.AbortCheckEvent as the eventId parameter. More...
 
Kitware.VTK.vtkObject.vtkObjectEventHandler AnimationCueTickEvt
 The AnimationCueTickEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.AnimationCueTickEvent as the eventId parameter. More...
 
Kitware.VTK.vtkObject.vtkObjectEventHandler AnyEvt
 The AnyEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.AnyEvent as the eventId parameter. More...
 
Kitware.VTK.vtkObject.vtkObjectEventHandler CharEvt
 The CharEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.CharEvent as the eventId parameter. More...
 
Kitware.VTK.vtkObject.vtkObjectEventHandler ConfigureEvt
 The ConfigureEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.ConfigureEvent as the eventId parameter. More...
 
Kitware.VTK.vtkObject.vtkObjectEventHandler ConnectionClosedEvt
 The ConnectionClosedEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.ConnectionClosedEvent as the eventId parameter. More...
 
Kitware.VTK.vtkObject.vtkObjectEventHandler ConnectionCreatedEvt
 The ConnectionCreatedEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.ConnectionCreatedEvent as the eventId parameter. More...
 
Kitware.VTK.vtkObject.vtkObjectEventHandler CreateTimerEvt
 The CreateTimerEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.CreateTimerEvent as the eventId parameter. More...
 
Kitware.VTK.vtkObject.vtkObjectEventHandler CursorChangedEvt
 The CursorChangedEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.CursorChangedEvent as the eventId parameter. More...
 
Kitware.VTK.vtkObject.vtkObjectEventHandler DeleteEvt
 The DeleteEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.DeleteEvent as the eventId parameter. More...
 
Kitware.VTK.vtkObject.vtkObjectEventHandler DestroyTimerEvt
 The DestroyTimerEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.DestroyTimerEvent as the eventId parameter. More...
 
Kitware.VTK.vtkObject.vtkObjectEventHandler DisableEvt
 The DisableEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.DisableEvent as the eventId parameter. More...
 
Kitware.VTK.vtkObject.vtkObjectEventHandler DomainModifiedEvt
 The DomainModifiedEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.DomainModifiedEvent as the eventId parameter. More...
 
Kitware.VTK.vtkObject.vtkObjectEventHandler EnableEvt
 The EnableEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.EnableEvent as the eventId parameter. More...
 
Kitware.VTK.vtkObject.vtkObjectEventHandler EndAnimationCueEvt
 The EndAnimationCueEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.EndAnimationCueEvent as the eventId parameter. More...
 
Kitware.VTK.vtkObject.vtkObjectEventHandler EndEvt
 The EndEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.EndEvent as the eventId parameter. More...
 
Kitware.VTK.vtkObject.vtkObjectEventHandler EndInteractionEvt
 The EndInteractionEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.EndInteractionEvent as the eventId parameter. More...
 
Kitware.VTK.vtkObject.vtkObjectEventHandler EndPickEvt
 The EndPickEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.EndPickEvent as the eventId parameter. More...
 
Kitware.VTK.vtkObject.vtkObjectEventHandler EndWindowLevelEvt
 The EndWindowLevelEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.EndWindowLevelEvent as the eventId parameter. More...
 
Kitware.VTK.vtkObject.vtkObjectEventHandler EnterEvt
 The EnterEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.EnterEvent as the eventId parameter. More...
 
Kitware.VTK.vtkObject.vtkObjectEventHandler ErrorEvt
 The ErrorEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.ErrorEvent as the eventId parameter. More...
 
Kitware.VTK.vtkObject.vtkObjectEventHandler ExecuteInformationEvt
 The ExecuteInformationEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.ExecuteInformationEvent as the eventId parameter. More...
 
Kitware.VTK.vtkObject.vtkObjectEventHandler ExitEvt
 The ExitEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.ExitEvent as the eventId parameter. More...
 
Kitware.VTK.vtkObject.vtkObjectEventHandler ExposeEvt
 The ExposeEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.ExposeEvent as the eventId parameter. More...
 
Kitware.VTK.vtkObject.vtkObjectEventHandler InteractionEvt
 The InteractionEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.InteractionEvent as the eventId parameter. More...
 
Kitware.VTK.vtkObject.vtkObjectEventHandler KeyPressEvt
 The KeyPressEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.KeyPressEvent as the eventId parameter. More...
 
Kitware.VTK.vtkObject.vtkObjectEventHandler KeyReleaseEvt
 The KeyReleaseEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.KeyReleaseEvent as the eventId parameter. More...
 
Kitware.VTK.vtkObject.vtkObjectEventHandler LeaveEvt
 The LeaveEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.LeaveEvent as the eventId parameter. More...
 
Kitware.VTK.vtkObject.vtkObjectEventHandler LeftButtonPressEvt
 The LeftButtonPressEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.LeftButtonPressEvent as the eventId parameter. More...
 
Kitware.VTK.vtkObject.vtkObjectEventHandler LeftButtonReleaseEvt
 The LeftButtonReleaseEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.LeftButtonReleaseEvent as the eventId parameter. More...
 
Kitware.VTK.vtkObject.vtkObjectEventHandler MiddleButtonPressEvt
 The MiddleButtonPressEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.MiddleButtonPressEvent as the eventId parameter. More...
 
Kitware.VTK.vtkObject.vtkObjectEventHandler MiddleButtonReleaseEvt
 The MiddleButtonReleaseEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.MiddleButtonReleaseEvent as the eventId parameter. More...
 
Kitware.VTK.vtkObject.vtkObjectEventHandler ModifiedEvt
 The ModifiedEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.ModifiedEvent as the eventId parameter. More...
 
Kitware.VTK.vtkObject.vtkObjectEventHandler MouseMoveEvt
 The MouseMoveEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.MouseMoveEvent as the eventId parameter. More...
 
Kitware.VTK.vtkObject.vtkObjectEventHandler MouseWheelBackwardEvt
 The MouseWheelBackwardEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.MouseWheelBackwardEvent as the eventId parameter. More...
 
Kitware.VTK.vtkObject.vtkObjectEventHandler MouseWheelForwardEvt
 The MouseWheelForwardEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.MouseWheelForwardEvent as the eventId parameter. More...
 
Kitware.VTK.vtkObject.vtkObjectEventHandler PickEvt
 The PickEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.PickEvent as the eventId parameter. More...
 
Kitware.VTK.vtkObject.vtkObjectEventHandler PlacePointEvt
 The PlacePointEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.PlacePointEvent as the eventId parameter. More...
 
Kitware.VTK.vtkObject.vtkObjectEventHandler PlaceWidgetEvt
 The PlaceWidgetEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.PlaceWidgetEvent as the eventId parameter. More...
 
Kitware.VTK.vtkObject.vtkObjectEventHandler ProgressEvt
 The ProgressEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.ProgressEvent as the eventId parameter. More...
 
Kitware.VTK.vtkObject.vtkObjectEventHandler PropertyModifiedEvt
 The PropertyModifiedEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.PropertyModifiedEvent as the eventId parameter. More...
 
Kitware.VTK.vtkObject.vtkObjectEventHandler RegisterEvt
 The RegisterEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.RegisterEvent as the eventId parameter. More...
 
Kitware.VTK.vtkObject.vtkObjectEventHandler RenderEvt
 The RenderEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.RenderEvent as the eventId parameter. More...
 
Kitware.VTK.vtkObject.vtkObjectEventHandler RenderWindowMessageEvt
 The RenderWindowMessageEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.RenderWindowMessageEvent as the eventId parameter. More...
 
Kitware.VTK.vtkObject.vtkObjectEventHandler ResetCameraClippingRangeEvt
 The ResetCameraClippingRangeEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.ResetCameraClippingRangeEvent as the eventId parameter. More...
 
Kitware.VTK.vtkObject.vtkObjectEventHandler ResetCameraEvt
 The ResetCameraEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.ResetCameraEvent as the eventId parameter. More...
 
Kitware.VTK.vtkObject.vtkObjectEventHandler ResetWindowLevelEvt
 The ResetWindowLevelEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.ResetWindowLevelEvent as the eventId parameter. More...
 
Kitware.VTK.vtkObject.vtkObjectEventHandler RightButtonPressEvt
 The RightButtonPressEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.RightButtonPressEvent as the eventId parameter. More...
 
Kitware.VTK.vtkObject.vtkObjectEventHandler RightButtonReleaseEvt
 The RightButtonReleaseEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.RightButtonReleaseEvent as the eventId parameter. More...
 
Kitware.VTK.vtkObject.vtkObjectEventHandler SelectionChangedEvt
 The SelectionChangedEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.SelectionChangedEvent as the eventId parameter. More...
 
Kitware.VTK.vtkObject.vtkObjectEventHandler SetOutputEvt
 The SetOutputEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.SetOutputEvent as the eventId parameter. More...
 
Kitware.VTK.vtkObject.vtkObjectEventHandler StartAnimationCueEvt
 The StartAnimationCueEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.StartAnimationCueEvent as the eventId parameter. More...
 
Kitware.VTK.vtkObject.vtkObjectEventHandler StartEvt
 The StartEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.StartEvent as the eventId parameter. More...
 
Kitware.VTK.vtkObject.vtkObjectEventHandler StartInteractionEvt
 The StartInteractionEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.StartInteractionEvent as the eventId parameter. More...
 
Kitware.VTK.vtkObject.vtkObjectEventHandler StartPickEvt
 The StartPickEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.StartPickEvent as the eventId parameter. More...
 
Kitware.VTK.vtkObject.vtkObjectEventHandler StartWindowLevelEvt
 The StartWindowLevelEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.StartWindowLevelEvent as the eventId parameter. More...
 
Kitware.VTK.vtkObject.vtkObjectEventHandler TimerEvt
 The TimerEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.TimerEvent as the eventId parameter. More...
 
Kitware.VTK.vtkObject.vtkObjectEventHandler UnRegisterEvt
 The UnRegisterEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.UnRegisterEvent as the eventId parameter. More...
 
Kitware.VTK.vtkObject.vtkObjectEventHandler UpdateEvt
 The UpdateEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.UpdateEvent as the eventId parameter. More...
 
Kitware.VTK.vtkObject.vtkObjectEventHandler UpdateInformationEvt
 The UpdateInformationEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.UpdateInformationEvent as the eventId parameter. More...
 
Kitware.VTK.vtkObject.vtkObjectEventHandler UpdatePropertyEvt
 The UpdatePropertyEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.UpdatePropertyEvent as the eventId parameter. More...
 
Kitware.VTK.vtkObject.vtkObjectEventHandler VolumeMapperComputeGradientsEndEvt
 The VolumeMapperComputeGradientsEndEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.VolumeMapperComputeGradientsEndEvent as the eventId parameter. More...
 
Kitware.VTK.vtkObject.vtkObjectEventHandler VolumeMapperComputeGradientsProgressEvt
 The VolumeMapperComputeGradientsProgressEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.VolumeMapperComputeGradientsProgressEvent as the eventId parameter. More...
 
Kitware.VTK.vtkObject.vtkObjectEventHandler VolumeMapperComputeGradientsStartEvt
 The VolumeMapperComputeGradientsStartEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.VolumeMapperComputeGradientsStartEvent as the eventId parameter. More...
 
Kitware.VTK.vtkObject.vtkObjectEventHandler VolumeMapperRenderEndEvt
 The VolumeMapperRenderEndEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.VolumeMapperRenderEndEvent as the eventId parameter. More...
 
Kitware.VTK.vtkObject.vtkObjectEventHandler VolumeMapperRenderProgressEvt
 The VolumeMapperRenderProgressEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.VolumeMapperRenderProgressEvent as the eventId parameter. More...
 
Kitware.VTK.vtkObject.vtkObjectEventHandler VolumeMapperRenderStartEvt
 The VolumeMapperRenderStartEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.VolumeMapperRenderStartEvent as the eventId parameter. More...
 
Kitware.VTK.vtkObject.vtkObjectEventHandler WarningEvt
 The WarningEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.WarningEvent as the eventId parameter. More...
 
Kitware.VTK.vtkObject.vtkObjectEventHandler WidgetActivateEvt
 The WidgetActivateEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.WidgetActivateEvent as the eventId parameter. More...
 
Kitware.VTK.vtkObject.vtkObjectEventHandler WidgetModifiedEvt
 The WidgetModifiedEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.WidgetModifiedEvent as the eventId parameter. More...
 
Kitware.VTK.vtkObject.vtkObjectEventHandler WidgetValueChangedEvt
 The WidgetValueChangedEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.WidgetValueChangedEvent as the eventId parameter. More...
 
Kitware.VTK.vtkObject.vtkObjectEventHandler WindowLevelEvt
 The WindowLevelEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.WindowLevelEvent as the eventId parameter. More...
 
Kitware.VTK.vtkObject.vtkObjectEventHandler WrongTagEvt
 The WrongTagEvt event is invoked when the sender's InvokeEvent method is called with vtkCommand.EventIds.WrongTagEvent as the eventId parameter. More...
 

Detailed Description

vtkDataTransferHelper - is a helper class that aids in transferring data between CPU memory and GPU memory.

Description vtkDataTransferHelper is a helper class that aids in transferring data between the CPU memory and the GPU memory. The data in GPU memory is stored as textures which that in CPU memory is stored as vtkDataArray. vtkDataTransferHelper provides API to transfer only a sub-extent of CPU structured data to/from the GPU.

vtkPixelBufferObject vtkTextureObject vtkOpenGLExtensionManager

Constructor & Destructor Documentation

static Kitware.VTK.vtkDataTransferHelper.vtkDataTransferHelper ( )
staticprivate

Automatically generated type registration mechanics.

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

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

Kitware.VTK.vtkDataTransferHelper.vtkDataTransferHelper ( )

Undocumented Block

Member Function Documentation

override void Kitware.VTK.vtkDataTransferHelper.Dispose ( bool  disposing)
protected

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

bool Kitware.VTK.vtkDataTransferHelper.Download ( )

old comment: Download Extent from GPU data buffer to CPU. GPU data size must exactly match Extent. CPU data buffer will be resized to match WholeExtent in which only the Extent will be filled with the GPU data. new comment: Download GPUExtent from GPU texture to CPU vtkDataArray. If Array is not provided, it will be created with the size of CPUExtent. But only the tuples covered by GPUExtent will be download. In this case, if GPUExtent does not cover all GPUExtent, some of the vtkDataArray will be uninitialized. Reminder: A=>B <=> !A||B

Precondition
texture_exists: texture!=0
array_not_empty: array==0 || array->GetNumberOfTuples()>0
valid_cpu_extent: this->GetCPUExtentIsValid()
valid_cpu_extent_size: array==0 || (CPUExtent[1]-CPUExtent[0]+1)*(CPUExtent[3]-CPUExtent[2]+1)*(CPUExtent[5]-CPUExtent[4]+1)==array->GetNumberOfTuples()
valid_gpu_extent: this->GetGPUExtentIsValid()
gpu_extent_in_cpu_extent: CPUExtent[0]<=GPUExtent[0] && GPUExtent[1]<=CPUExtent[1] && CPUExtent[2]<=GPUExtent[2] && GPUExtent[3]<=CPUExtent[3] && CPUExtent[4]<=GPUExtent[4] && GPUExtent[5]<=CPUExtent[5]
gpu_texture_size: !this->GetTextureExtentIsValid() || (GPUExtent[1]-GPUExtent[0]+1)*(GPUExtent[3]-GPUExtent[2]+1)*(GPUExtent[5]-GPUExtent[4]+1)==(TextureExtent[1]-TextureExtent[0]+1)*(TextureExtent[3]-TextureExtent[2]+1)*(TextureExtent[5]-TextureExtent[4]+1)
valid_components: array==0 || array->GetNumberOfComponents()<=4
components_match: array==0 || (texture->GetComponents()==array->GetNumberOfComponents())
bool Kitware.VTK.vtkDataTransferHelper.DownloadAsync1 ( )

Splits the download in two operations

bool Kitware.VTK.vtkDataTransferHelper.DownloadAsync2 ( )

Splits the download in two operations

virtual vtkDataArray Kitware.VTK.vtkDataTransferHelper.GetArray ( )
virtual

Get/Set the CPU data buffer. Initial value is 0.

Here is the call graph for this function:

vtkRenderWindow Kitware.VTK.vtkDataTransferHelper.GetContext ( )

Get/Set the context. Context must be a vtkOpenGLRenderWindow. This does not increase the reference count of the context to avoid reference loops. SetContext() may raise an error is the OpenGL context does not support the required OpenGL extensions.

Here is the call graph for this function:

virtual int [] Kitware.VTK.vtkDataTransferHelper.GetCPUExtent ( )
virtual

Set the CPU data extent. The extent matches the vtkDataArray size. If the vtkDataArray comes from an vtkImageData and it is part of the point data, it is usually the vtkImageData extent. It can be on cell data too, but in this case it does not match the vtkImageData extent. If the vtkDataArray comes from a vtkDataSet, just set it to a one-dimenstional extent equal to the number of tuples. Initial value is (0,0,0,0,0,0), a valid one tuple array.

virtual void Kitware.VTK.vtkDataTransferHelper.GetCPUExtent ( ref int  _arg1,
ref int  _arg2,
ref int  _arg3,
ref int  _arg4,
ref int  _arg5,
ref int  _arg6 
)
virtual

Set the CPU data extent. The extent matches the vtkDataArray size. If the vtkDataArray comes from an vtkImageData and it is part of the point data, it is usually the vtkImageData extent. It can be on cell data too, but in this case it does not match the vtkImageData extent. If the vtkDataArray comes from a vtkDataSet, just set it to a one-dimenstional extent equal to the number of tuples. Initial value is (0,0,0,0,0,0), a valid one tuple array.

virtual void Kitware.VTK.vtkDataTransferHelper.GetCPUExtent ( IntPtr  _arg)
virtual

Set the CPU data extent. The extent matches the vtkDataArray size. If the vtkDataArray comes from an vtkImageData and it is part of the point data, it is usually the vtkImageData extent. It can be on cell data too, but in this case it does not match the vtkImageData extent. If the vtkDataArray comes from a vtkDataSet, just set it to a one-dimenstional extent equal to the number of tuples. Initial value is (0,0,0,0,0,0), a valid one tuple array.

bool Kitware.VTK.vtkDataTransferHelper.GetCPUExtentIsValid ( )

Tells if CPUExtent is valid. True if min extent<=max extent.

bool Kitware.VTK.vtkDataTransferHelper.GetExtentIsValid ( IntPtr  extent)

Tells if the given extent (6 int) is valid. True if min extent<=max extent.

Precondition
extent_exists: extent!=0
virtual int [] Kitware.VTK.vtkDataTransferHelper.GetGPUExtent ( )
virtual

Set the GPU data extent. This is the sub-extent to copy from or to the GPU. This extent matches the size of the data to transfer. GPUExtent and TextureExtent don't have to match (GPUExtent can be 1D whereas TextureExtent is 2D) but the number of elements have to match. Initial value is (0,0,0,0,0,0), a valid one tuple array.

virtual void Kitware.VTK.vtkDataTransferHelper.GetGPUExtent ( ref int  _arg1,
ref int  _arg2,
ref int  _arg3,
ref int  _arg4,
ref int  _arg5,
ref int  _arg6 
)
virtual

Set the GPU data extent. This is the sub-extent to copy from or to the GPU. This extent matches the size of the data to transfer. GPUExtent and TextureExtent don't have to match (GPUExtent can be 1D whereas TextureExtent is 2D) but the number of elements have to match. Initial value is (0,0,0,0,0,0), a valid one tuple array.

virtual void Kitware.VTK.vtkDataTransferHelper.GetGPUExtent ( IntPtr  _arg)
virtual

Set the GPU data extent. This is the sub-extent to copy from or to the GPU. This extent matches the size of the data to transfer. GPUExtent and TextureExtent don't have to match (GPUExtent can be 1D whereas TextureExtent is 2D) but the number of elements have to match. Initial value is (0,0,0,0,0,0), a valid one tuple array.

bool Kitware.VTK.vtkDataTransferHelper.GetGPUExtentIsValid ( )

Tells if GPUExtent is valid. True if min extent<=max extent.

virtual int Kitware.VTK.vtkDataTransferHelper.GetMinTextureDimension ( )
virtual

Define the minimal dimension of the texture regardless of the dimensions of the TextureExtent. Initial value is 1. A texture extent can have a given dimension 0D (one value), 1D, 2D or 3D. By default 0D and 1D are translated into a 1D texture, 2D is translated into a 2D texture, 3D is translated into a 3D texture. To make life easier when writting GLSL code and use only one type of sampler (ex: sampler2d), the default behavior can be changed by forcing a type of texture with this ivar. 1: default behavior. Initial value. 2: force 0D and 1D to be in a 2D texture 3: force 0D, 1D and 2D texture to be in a 3D texture.

bool Kitware.VTK.vtkDataTransferHelper.GetShaderSupportsTextureInt ( )

Splits the download in two operations

virtual vtkTextureObject Kitware.VTK.vtkDataTransferHelper.GetTexture ( )
virtual

Get/Set the GPU data buffer. Initial value is 0.

Here is the call graph for this function:

virtual int [] Kitware.VTK.vtkDataTransferHelper.GetTextureExtent ( )
virtual

Set the texture data extent. This is the extent of the texture image that will receive the data. This extent matches the size of the data to transfer. If it is set to an invalid extent, GPUExtent is used. See more comment on GPUExtent. Initial value is an invalid extent.

virtual void Kitware.VTK.vtkDataTransferHelper.GetTextureExtent ( ref int  _arg1,
ref int  _arg2,
ref int  _arg3,
ref int  _arg4,
ref int  _arg5,
ref int  _arg6 
)
virtual

Set the texture data extent. This is the extent of the texture image that will receive the data. This extent matches the size of the data to transfer. If it is set to an invalid extent, GPUExtent is used. See more comment on GPUExtent. Initial value is an invalid extent.

virtual void Kitware.VTK.vtkDataTransferHelper.GetTextureExtent ( IntPtr  _arg)
virtual

Set the texture data extent. This is the extent of the texture image that will receive the data. This extent matches the size of the data to transfer. If it is set to an invalid extent, GPUExtent is used. See more comment on GPUExtent. Initial value is an invalid extent.

bool Kitware.VTK.vtkDataTransferHelper.GetTextureExtentIsValid ( )

Tells if TextureExtent is valid. True if min extent<=max extent.

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

Undocumented Block

Reimplemented from Kitware.VTK.vtkObjectBase.

static bool Kitware.VTK.vtkDataTransferHelper.IsSupported ( vtkRenderWindow  renWin)
static

Returns if the context supports the required extensions.

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

Undocumented Block

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

Undocumented Block

new vtkDataTransferHelper Kitware.VTK.vtkDataTransferHelper.NewInstance ( )

Undocumented Block

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

Undocumented Block

Here is the call graph for this function:

void Kitware.VTK.vtkDataTransferHelper.SetArray ( vtkDataArray  array)

Get/Set the CPU data buffer. Initial value is 0.

void Kitware.VTK.vtkDataTransferHelper.SetContext ( vtkRenderWindow  context)

Get/Set the context. Context must be a vtkOpenGLRenderWindow. This does not increase the reference count of the context to avoid reference loops. SetContext() may raise an error is the OpenGL context does not support the required OpenGL extensions.

virtual void Kitware.VTK.vtkDataTransferHelper.SetCPUExtent ( int  _arg1,
int  _arg2,
int  _arg3,
int  _arg4,
int  _arg5,
int  _arg6 
)
virtual

Set the CPU data extent. The extent matches the vtkDataArray size. If the vtkDataArray comes from an vtkImageData and it is part of the point data, it is usually the vtkImageData extent. It can be on cell data too, but in this case it does not match the vtkImageData extent. If the vtkDataArray comes from a vtkDataSet, just set it to a one-dimenstional extent equal to the number of tuples. Initial value is (0,0,0,0,0,0), a valid one tuple array.

virtual void Kitware.VTK.vtkDataTransferHelper.SetCPUExtent ( IntPtr  _arg)
virtual

Set the CPU data extent. The extent matches the vtkDataArray size. If the vtkDataArray comes from an vtkImageData and it is part of the point data, it is usually the vtkImageData extent. It can be on cell data too, but in this case it does not match the vtkImageData extent. If the vtkDataArray comes from a vtkDataSet, just set it to a one-dimenstional extent equal to the number of tuples. Initial value is (0,0,0,0,0,0), a valid one tuple array.

virtual void Kitware.VTK.vtkDataTransferHelper.SetGPUExtent ( int  _arg1,
int  _arg2,
int  _arg3,
int  _arg4,
int  _arg5,
int  _arg6 
)
virtual

Set the GPU data extent. This is the sub-extent to copy from or to the GPU. This extent matches the size of the data to transfer. GPUExtent and TextureExtent don't have to match (GPUExtent can be 1D whereas TextureExtent is 2D) but the number of elements have to match. Initial value is (0,0,0,0,0,0), a valid one tuple array.

virtual void Kitware.VTK.vtkDataTransferHelper.SetGPUExtent ( IntPtr  _arg)
virtual

Set the GPU data extent. This is the sub-extent to copy from or to the GPU. This extent matches the size of the data to transfer. GPUExtent and TextureExtent don't have to match (GPUExtent can be 1D whereas TextureExtent is 2D) but the number of elements have to match. Initial value is (0,0,0,0,0,0), a valid one tuple array.

virtual void Kitware.VTK.vtkDataTransferHelper.SetMinTextureDimension ( int  _arg)
virtual

Define the minimal dimension of the texture regardless of the dimensions of the TextureExtent. Initial value is 1. A texture extent can have a given dimension 0D (one value), 1D, 2D or 3D. By default 0D and 1D are translated into a 1D texture, 2D is translated into a 2D texture, 3D is translated into a 3D texture. To make life easier when writting GLSL code and use only one type of sampler (ex: sampler2d), the default behavior can be changed by forcing a type of texture with this ivar. 1: default behavior. Initial value. 2: force 0D and 1D to be in a 2D texture 3: force 0D, 1D and 2D texture to be in a 3D texture.

void Kitware.VTK.vtkDataTransferHelper.SetShaderSupportsTextureInt ( bool  value)

Splits the download in two operations

void Kitware.VTK.vtkDataTransferHelper.SetTexture ( vtkTextureObject  texture)

Get/Set the GPU data buffer. Initial value is 0.

virtual void Kitware.VTK.vtkDataTransferHelper.SetTextureExtent ( int  _arg1,
int  _arg2,
int  _arg3,
int  _arg4,
int  _arg5,
int  _arg6 
)
virtual

Set the texture data extent. This is the extent of the texture image that will receive the data. This extent matches the size of the data to transfer. If it is set to an invalid extent, GPUExtent is used. See more comment on GPUExtent. Initial value is an invalid extent.

virtual void Kitware.VTK.vtkDataTransferHelper.SetTextureExtent ( IntPtr  _arg)
virtual

Set the texture data extent. This is the extent of the texture image that will receive the data. This extent matches the size of the data to transfer. If it is set to an invalid extent, GPUExtent is used. See more comment on GPUExtent. Initial value is an invalid extent.

bool Kitware.VTK.vtkDataTransferHelper.Upload ( int  components,
IntPtr  componentList 
)

Old comment. Upload Extent from CPU data buffer to GPU. The WholeExtent must match the Array size. New comment. Upload GPUExtent from CPU vtkDataArray to GPU texture. It is possible to send a subset of the components or to specify and order of components or both. If components=0, componentList is ignored and all components are passed, a texture cannot have more than 4 components.

Precondition
array_exists: array!=0
array_not_empty: array->GetNumberOfTuples()>0
valid_cpu_extent: this->GetCPUExtentIsValid()
valid_cpu_extent_size: (CPUExtent[1]-CPUExtent[0]+1)*(CPUExtent[3]-CPUExtent[2]+1)*(CPUExtent[5]-CPUExtent[4]+1)==array->GetNumberOfTuples()
valid_gpu_extent: this->GetGPUExtentIsValid()
gpu_extent_in_cpu_extent: CPUExtent[0]<=GPUExtent[0] && GPUExtent[1]<=CPUExtent[1] && CPUExtent[2]<=GPUExtent[2] && GPUExtent[3]<=CPUExtent[3] && CPUExtent[4]<=GPUExtent[4] && GPUExtent[5]<=CPUExtent[5]
gpu_texture_size: !this->GetTextureExtentIsValid() || (GPUExtent[1]-GPUExtent[0]+1)*(GPUExtent[3]-GPUExtent[2]+1)*(GPUExtent[5]-GPUExtent[4]+1)==(TextureExtent[1]-TextureExtent[0]+1)*(TextureExtent[3]-TextureExtent[2]+1)*(TextureExtent[5]-TextureExtent[4]+1)
texture_can_exist_or_not: texture==0 || texture!=0
valid_components: (components==0 && componentList==0 && array->GetNumberOfComponents()<=4) || (components>=1 && components<=array->GetNumberOfComponents() && components<=4 && componentList!=0)

Member Data Documentation

new readonly string Kitware.VTK.vtkDataTransferHelper.MRClassNameKey = "21vtkDataTransferHelper"
static

Automatically generated type registration mechanics.

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

Automatically generated type registration mechanics.


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