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

vtkVisibleCellSelector - A helper that orchestrates color buffer visible cell selection. This is deprecated. Refer to vtkHardwareSelector instead. More...

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

List of all members.

Public Member Functions

 vtkVisibleCellSelector (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkVisibleCellSelector ()
 Undocumented Block.
vtkProp GetActorFromId (int id)
 After a select, this will return a pointer to the actor corresponding to a particular id. This will return NULL if id is out of range.
void GetArea (ref uint x0, ref uint y0, ref uint x1, ref uint y1)
 The caller of SetArea can use to check for cropped limits.
void GetPixelSelection (IntPtr displayPos, ref int procId, ref int cellId, ref int vertId, vtkProp actorPtr)
 Get the cellId, vertexIds, actor, processor rendering the actor at a given display position. Makes sense only after Select() has been called.
virtual uint GetProcessorId ()
 Call to let this know what processor number to render as in the processor select pass. Internally this adds 1 to pid because 0 is reserved for miss.
void GetSelectedIds (vtkIdTypeArray ToCopyInto)
 After Select(), this will return the list of selected Ids. The ProcessorId and Actor Id are returned in the first two components. The CellId is returned in the last two components (only 64 bits total).
void GetSelectedIds (vtkSelection ToCopyInto)
 After Select(), this will return the list of selected Ids.
void GetSelectedVertices (vtkIdTypeArray VertexPointers, vtkIdTypeArray VertexIds)
 After Select(), (assuming DoVertexId is on), the will return arrays that describe which cell vertices are visible. The VertexPointers array contains one index into the VertexIds array for every visible cell. Any index may be -1 in which case no vertices were visible for that cell. The VertexIds array contains a set of integers for each cell that has visible vertices. The first entry in the set is the number of visible vertices. The rest are visible vertex ranks. A set such at 2,0,4, means that a particular polygon's first and fifth vertices were visible.
override int IsA (string type)
 Undocumented Block.
new vtkVisibleCellSelector NewInstance ()
 Undocumented Block.
void PrintSelectedIds (vtkIdTypeArray IdsToPrint)
 For debugging - prints out the list of selected ids.
void Select ()
 Execute the selection algorithm.
void SetArea (uint x0, uint y0, uint x1, uint y1)
 Call to set the selection area region. This crops the selected area to the renderers pixel limits.
virtual void SetProcessorId (uint pid)
 Call to let this know what processor number to render as in the processor select pass. Internally this adds 1 to pid because 0 is reserved for miss.
void SetRenderPasses (int DoProcessor, int DoActor, int DoCellIdHi, int DoCellIdMid, int DoCellIdLo, int DoVertexId)
 Call to let this know what selection render passes to do. If you have only one processor or one actor, you can leave DoProcessor and DoActor as false (the default). If you have less than 2^48 cells in any actor, you do not need the CellIdHi pass, or similarly if you have less than 2^24 cells, you do not need DoCellIdMid. The DoPointId will enable another render pass for determining visible vertices.
virtual void SetRenderer (vtkRenderer arg0)
 Call to let this know where to select within.

Static Public Member Functions

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

Public Attributes

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

Static Public Attributes

static new readonly string MRClassNameKey = "22vtkVisibleCellSelector"
 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 vtkVisibleCellSelector_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkVisibleCellSelector_GetActorFromId_01 (HandleRef pThis, int id, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkVisibleCellSelector_GetArea_02 (HandleRef pThis, ref uint x0, ref uint y0, ref uint x1, ref uint y1)
static internal void vtkVisibleCellSelector_GetPixelSelection_03 (HandleRef pThis, IntPtr displayPos, ref int procId, ref int cellId, ref int vertId, HandleRef actorPtr)
static internal uint vtkVisibleCellSelector_GetProcessorId_04 (HandleRef pThis)
static internal void vtkVisibleCellSelector_GetSelectedIds_05 (HandleRef pThis, HandleRef ToCopyInto)
static internal void vtkVisibleCellSelector_GetSelectedIds_06 (HandleRef pThis, HandleRef ToCopyInto)
static internal void vtkVisibleCellSelector_GetSelectedVertices_07 (HandleRef pThis, HandleRef VertexPointers, HandleRef VertexIds)
static internal int vtkVisibleCellSelector_IsA_08 (HandleRef pThis, string type)
static internal int vtkVisibleCellSelector_IsTypeOf_09 (string type)
static internal IntPtr vtkVisibleCellSelector_NewInstance_11 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkVisibleCellSelector_PrintSelectedIds_12 (HandleRef pThis, HandleRef IdsToPrint)
static internal IntPtr vtkVisibleCellSelector_SafeDownCast_13 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkVisibleCellSelector_Select_14 (HandleRef pThis)
static internal void vtkVisibleCellSelector_SetArea_15 (HandleRef pThis, uint x0, uint y0, uint x1, uint y1)
static internal void vtkVisibleCellSelector_SetProcessorId_16 (HandleRef pThis, uint pid)
static internal void vtkVisibleCellSelector_SetRenderPasses_17 (HandleRef pThis, int DoProcessor, int DoActor, int DoCellIdHi, int DoCellIdMid, int DoCellIdLo, int DoVertexId)
static internal void vtkVisibleCellSelector_SetRenderer_18 (HandleRef pThis, HandleRef arg0)

Static Private Member Functions

static vtkVisibleCellSelector ()
 Automatically generated type registration mechanics.

Detailed Description

vtkVisibleCellSelector - A helper that orchestrates color buffer visible cell selection. This is deprecated. Refer to vtkHardwareSelector instead.

Description DEPRECATED: Please refer to vtkHardwareSelector instead. This class can be used to determine what cells are visible within a given rectangle of the RenderWindow. To use it, call in order, SetRenderer(), SetArea(), SetProcessorId(), SetRenderPasses(), and then Select(). Select will cause the attached vtkRenderer to render in a special color mode, where each cell is given it own color so that later inspection of the Rendered Pixels can determine what cells are visible. In practice up to five different rendering passes may occur depending on your choices in SetRenderPasses. After Select(), a list of the visible cells can be obtained by calling GetSelectedIds().

Limitations: Antialiasing will break this class. If your graphics card settings force their use this class will return invalid results.

Currently only cells from PolyDataMappers can be selected from. When vtkRenderer is put into a SelectMode, it temporarily swaps in a new vtkIdentColoredPainter to do the color index rendering of each cell in each vtkProp that it renders. Until alternatives to vtkIdentColoredPainter exist that can do a similar coloration of other vtkDataSet types, only polygonal data can be selected. If you need to select other data types, consider using vtkDataSetMapper and turning on it's PassThroughCellIds feature, or using vtkFrustumExtractor.

Only Opaque geometry in Actors is selected from. Assemblies and LODMappers are not currently supported.

During selection, visible datasets that can not be selected from are temporarily hidden so as not to produce invalid indices from their colors.

vtkIdentColoredPainter


Constructor & Destructor Documentation

Automatically generated type registration mechanics.

Kitware.VTK.vtkVisibleCellSelector.vtkVisibleCellSelector ( 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.vtkVisibleCellSelector.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.vtkObject.

After a select, this will return a pointer to the actor corresponding to a particular id. This will return NULL if id is out of range.

Here is the call graph for this function:

void Kitware.VTK.vtkVisibleCellSelector.GetArea ( ref uint  x0,
ref uint  y0,
ref uint  x1,
ref uint  y1 
)

The caller of SetArea can use to check for cropped limits.

void Kitware.VTK.vtkVisibleCellSelector.GetPixelSelection ( IntPtr  displayPos,
ref int  procId,
ref int  cellId,
ref int  vertId,
vtkProp  actorPtr 
)

Get the cellId, vertexIds, actor, processor rendering the actor at a given display position. Makes sense only after Select() has been called.

Call to let this know what processor number to render as in the processor select pass. Internally this adds 1 to pid because 0 is reserved for miss.

After Select(), this will return the list of selected Ids. The ProcessorId and Actor Id are returned in the first two components. The CellId is returned in the last two components (only 64 bits total).

After Select(), this will return the list of selected Ids.

After Select(), (assuming DoVertexId is on), the will return arrays that describe which cell vertices are visible. The VertexPointers array contains one index into the VertexIds array for every visible cell. Any index may be -1 in which case no vertices were visible for that cell. The VertexIds array contains a set of integers for each cell that has visible vertices. The first entry in the set is the number of visible vertices. The rest are visible vertex ranks. A set such at 2,0,4, means that a particular polygon's first and fifth vertices were visible.

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

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

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

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

For debugging - prints out the list of selected ids.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

Here is the call graph for this function:

Execute the selection algorithm.

void Kitware.VTK.vtkVisibleCellSelector.SetArea ( uint  x0,
uint  y0,
uint  x1,
uint  y1 
)

Call to set the selection area region. This crops the selected area to the renderers pixel limits.

virtual void Kitware.VTK.vtkVisibleCellSelector.SetProcessorId ( uint  pid) [virtual]

Call to let this know what processor number to render as in the processor select pass. Internally this adds 1 to pid because 0 is reserved for miss.

Call to let this know where to select within.

void Kitware.VTK.vtkVisibleCellSelector.SetRenderPasses ( int  DoProcessor,
int  DoActor,
int  DoCellIdHi,
int  DoCellIdMid,
int  DoCellIdLo,
int  DoVertexId 
)

Call to let this know what selection render passes to do. If you have only one processor or one actor, you can leave DoProcessor and DoActor as false (the default). If you have less than 2^48 cells in any actor, you do not need the CellIdHi pass, or similarly if you have less than 2^24 cells, you do not need DoCellIdMid. The DoPointId will enable another render pass for determining visible vertices.

static internal IntPtr Kitware.VTK.vtkVisibleCellSelector.vtkVisibleCellSelector_GetActorFromId_01 ( HandleRef  pThis,
int  id,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkVisibleCellSelector.vtkVisibleCellSelector_GetArea_02 ( HandleRef  pThis,
ref uint  x0,
ref uint  y0,
ref uint  x1,
ref uint  y1 
) [private]
static internal void Kitware.VTK.vtkVisibleCellSelector.vtkVisibleCellSelector_GetPixelSelection_03 ( HandleRef  pThis,
IntPtr  displayPos,
ref int  procId,
ref int  cellId,
ref int  vertId,
HandleRef  actorPtr 
) [private]
static internal uint Kitware.VTK.vtkVisibleCellSelector.vtkVisibleCellSelector_GetProcessorId_04 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkVisibleCellSelector.vtkVisibleCellSelector_GetSelectedIds_05 ( HandleRef  pThis,
HandleRef  ToCopyInto 
) [private]
static internal void Kitware.VTK.vtkVisibleCellSelector.vtkVisibleCellSelector_GetSelectedIds_06 ( HandleRef  pThis,
HandleRef  ToCopyInto 
) [private]
static internal void Kitware.VTK.vtkVisibleCellSelector.vtkVisibleCellSelector_GetSelectedVertices_07 ( HandleRef  pThis,
HandleRef  VertexPointers,
HandleRef  VertexIds 
) [private]
static internal int Kitware.VTK.vtkVisibleCellSelector.vtkVisibleCellSelector_IsA_08 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkVisibleCellSelector.vtkVisibleCellSelector_IsTypeOf_09 ( string  type) [private]
static internal IntPtr Kitware.VTK.vtkVisibleCellSelector.vtkVisibleCellSelector_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkVisibleCellSelector.vtkVisibleCellSelector_NewInstance_11 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkVisibleCellSelector.vtkVisibleCellSelector_PrintSelectedIds_12 ( HandleRef  pThis,
HandleRef  IdsToPrint 
) [private]
static internal IntPtr Kitware.VTK.vtkVisibleCellSelector.vtkVisibleCellSelector_SafeDownCast_13 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkVisibleCellSelector.vtkVisibleCellSelector_Select_14 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkVisibleCellSelector.vtkVisibleCellSelector_SetArea_15 ( HandleRef  pThis,
uint  x0,
uint  y0,
uint  x1,
uint  y1 
) [private]
static internal void Kitware.VTK.vtkVisibleCellSelector.vtkVisibleCellSelector_SetProcessorId_16 ( HandleRef  pThis,
uint  pid 
) [private]
static internal void Kitware.VTK.vtkVisibleCellSelector.vtkVisibleCellSelector_SetRenderer_18 ( HandleRef  pThis,
HandleRef  arg0 
) [private]
static internal void Kitware.VTK.vtkVisibleCellSelector.vtkVisibleCellSelector_SetRenderPasses_17 ( HandleRef  pThis,
int  DoProcessor,
int  DoActor,
int  DoCellIdHi,
int  DoCellIdMid,
int  DoCellIdLo,
int  DoVertexId 
) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkVisibleCellSelector.MRClassNameKey = "22vtkVisibleCellSelector" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkObject.

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

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkObject.


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