More...

Inheritance diagram for HPS.HighlightControl:
HPS.Control HPS.Object

Public Member Functions

override void Dispose ()
 
HPS.HighlightControl Highlight (HPS.SelectionResults in_items, HPS.HighlightOptionsKit in_options)
 Highlight the specified selection results using the specified highlight options. More...
 
HPS.HighlightControl Highlight (HPS.SelectionItem in_item, HPS.HighlightOptionsKit in_options)
 Highlight the specified selection item using the specified highlight options. More...
 
HPS.HighlightControl Highlight (HPS.SearchResults in_items, HPS.HighlightOptionsKit in_options)
 Highlight the specified search results using the specified highlight options. More...
 
HPS.HighlightControl Highlight (HPS.KeyPath in_item, HPS.HighlightOptionsKit in_options)
 Highlight the specified key path using the specified highlight options. More...
 
HPS.HighlightControl Highlight (HPS.Key in_item, HPS.HighlightOptionsKit in_options)
 Highlight the specified key using the specified highlight options. More...
 
HPS.HighlightControl Highlight (HPS.KeyPath in_item, HPS.HighlightOptionsKit in_options, ulong[] in_vertices, ulong[] in_edges1, ulong[] in_edges2, ulong[] in_faces)
 Highlight specified subentities for the specified key path using the specified highlight options. More...
 
HPS.HighlightControl Highlight (HPS.Key in_item, HPS.HighlightOptionsKit in_options, ulong[] in_vertices, ulong[] in_edges1, ulong[] in_edges2, ulong[] in_faces)
 Highlight the specified key using the specified highlight options. More...
 
 HighlightControl (HPS.WindowKey in_window)
 This constructor creates a HighlightControl object which is tied to the specified window. More...
 
 HighlightControl (HPS.HighlightControl in_that)
 The copy constructor creates a HighlightControl object that shares the underlying smart-pointer of the source HighlightControl. More...
 
override HPS.Type ObjectType ()
 This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object. More...
 
override HPS.Type Type ()
 This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types. More...
 
HPS.HighlightControl Unhighlight (HPS.SelectionResults in_items, HPS.HighlightOptionsKit in_options)
 Unhighlight the specified selection results by removing the specified highlight options. More...
 
HPS.HighlightControl Unhighlight (HPS.SelectionResults in_items)
 Unhighlight the specified selection results by removing the specified highlight options. More...
 
HPS.HighlightControl Unhighlight (HPS.SelectionItem in_item, HPS.HighlightOptionsKit in_options)
 Unhighlight the specified selection item by removing the specified highlight options. More...
 
HPS.HighlightControl Unhighlight (HPS.SelectionItem in_item)
 Unhighlight the specified selection item by removing the specified highlight options. More...
 
HPS.HighlightControl Unhighlight (HPS.SearchResults in_items, HPS.HighlightOptionsKit in_options)
 Unhighlight the specified search results by removing the specified highlight options. More...
 
HPS.HighlightControl Unhighlight (HPS.SearchResults in_items)
 Unhighlight the specified search results by removing the specified highlight options. More...
 
HPS.HighlightControl Unhighlight (HPS.KeyPath in_item, HPS.HighlightOptionsKit in_options)
 Unhighlight the specified key path by removing the specified highlight options. More...
 
HPS.HighlightControl Unhighlight (HPS.KeyPath in_item)
 Unhighlight the specified key path by removing the specified highlight options. More...
 
HPS.HighlightControl Unhighlight (HPS.Key in_item, HPS.HighlightOptionsKit in_options)
 Unhighlight the specified key by removing the specified highlight options. More...
 
HPS.HighlightControl Unhighlight (HPS.Key in_item)
 Unhighlight the specified key by removing the specified highlight options. More...
 
HPS.HighlightControl Unhighlight (HPS.KeyPath in_item, HPS.HighlightOptionsKit in_options, ulong[] in_vertices, ulong[] in_edges1, ulong[] in_edges2, ulong[] in_faces)
 Unhighlight subentities from the specified key path by removing the specified highlight options. More...
 
HPS.HighlightControl Unhighlight (HPS.Key in_item, HPS.HighlightOptionsKit in_options, ulong[] in_vertices, ulong[] in_edges1, ulong[] in_edges2, ulong[] in_faces)
 Unhighlight subentities from the specified item by removing the specified highlight options. More...
 
HPS.HighlightControl Unhighlight (HPS.HighlightOptionsKit in_options)
 Unhighlight geometry which was highlighted with the specified HighlightOptionsKit. More...
 
HPS.HighlightControl UnhighlightEverything ()
 Unhighlight everything in the window associated with this HighlightControl. More...
 
- Public Member Functions inherited from HPS.Control
 Control (HPS.Control in_that)
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 Indicates whether this object has any values set on it. More...
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 Returns an identifier that can be used to identify which instance of a class an object is. Different keys and controls will return the same value if they are backed by the same database resource. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
 Object (HPS.Object that)
 
virtual void Reset ()
 Resets this object to its initial, uninitialized state. More...
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 
- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

Detailed Description

The HPS.HighlightControl class is a smart pointer that is tied to a database object. It is used to control highlight and unhighlight operations on selection results, search results, key paths and keys. This table lists default * values for the various segment attributes accessible from HPS.HighlightControl.

Constructor & Destructor Documentation

HPS.HighlightControl.HighlightControl ( HPS.WindowKey  in_window)
inline

This constructor creates a HighlightControl object which is tied to the specified window.

Parameters
in_windowThe window which this HighlightControl should operate on.
HPS.HighlightControl.HighlightControl ( HPS.HighlightControl  in_that)
inline

The copy constructor creates a HighlightControl object that shares the underlying smart-pointer of the source HighlightControl.

Parameters
in_thatThe source HighlightControl to copy.

Member Function Documentation

HPS.HighlightControl HPS.HighlightControl.Highlight ( HPS.SelectionResults  in_items,
HPS.HighlightOptionsKit  in_options 
)
inline

Highlight the specified selection results using the specified highlight options.

Parameters
in_itemsThe selection results to highlight. If there are invalid selection items in the selection results, an exception will be thrown.
in_optionsThe options to use when performing the highlight. If there is no highlight style specified, an exception will be thrown.
Returns
    A reference to this HighlightControl.
HPS.HighlightControl HPS.HighlightControl.Highlight ( HPS.SelectionItem  in_item,
HPS.HighlightOptionsKit  in_options 
)
inline

Highlight the specified selection item using the specified highlight options.

Parameters
in_itemThe selection item to highlight. If the selection item is invalid, an exception will be thrown.
in_optionsThe options to use when performing the highlight. If there is no highlight style specified, an exception will be thrown.
Returns
    A reference to this HighlightControl.
HPS.HighlightControl HPS.HighlightControl.Highlight ( HPS.SearchResults  in_items,
HPS.HighlightOptionsKit  in_options 
)
inline

Highlight the specified search results using the specified highlight options.

Parameters
in_itemsThe search results to highlight. If there are invalid keys in the selection results, an exception will be thrown.
in_optionsThe options to use when performing the highlight. If there is no highlight style specified, an exception will be thrown.
Returns
    A reference to this HighlightControl.
HPS.HighlightControl HPS.HighlightControl.Highlight ( HPS.KeyPath  in_item,
HPS.HighlightOptionsKit  in_options 
)
inline

Highlight the specified key path using the specified highlight options.

Parameters
in_itemThe key path to highlight. If there are no keys or invalid keys in the key path, an exception will be thrown.
in_optionsThe options to use when performing the highlight. If there is no highlight style specified, an exception will be thrown.
Returns
    A reference to this HighlightControl.
HPS.HighlightControl HPS.HighlightControl.Highlight ( HPS.Key  in_item,
HPS.HighlightOptionsKit  in_options 
)
inline

Highlight the specified key using the specified highlight options.

Parameters
in_itemThe key to highlight. If the key is invalid, an exception will be thrown.
in_optionsThe options to use when performing the highlight. If there is no highlight style specified, an exception will be thrown.
Returns
    A reference to this HighlightControl.
HPS.HighlightControl HPS.HighlightControl.Highlight ( HPS.KeyPath  in_item,
HPS.HighlightOptionsKit  in_options,
ulong[]  in_vertices,
ulong[]  in_edges1,
ulong[]  in_edges2,
ulong[]  in_faces 
)
inline

Highlight specified subentities for the specified key path using the specified highlight options.

Parameters
in_itemThe key path to highlight. If there are no keys or invalid keys in the key path, an exception will be thrown.
in_optionsThe options to use when performing the highlight. If there is no highlight style specified, an exception will be thrown.
in_verticesAn array of vertex indices, specfying vertices to highlight.
in_edges1An array of vertex indices, which when paired with the corresponding entries in the in_edges2 array, define a list of edges to highlight.
in_edges2An array of vertex indices to be paired with entries in in_edges1 array to define the edge list.
in_facesAn array of faces indices specifying faces to highlight.
Returns
    A reference to this HighlightControl.
HPS.HighlightControl HPS.HighlightControl.Highlight ( HPS.Key  in_item,
HPS.HighlightOptionsKit  in_options,
ulong[]  in_vertices,
ulong[]  in_edges1,
ulong[]  in_edges2,
ulong[]  in_faces 
)
inline

Highlight the specified key using the specified highlight options.

Parameters
in_itemThe key to highlight. If the key is invalid, an exception will be thrown.
in_optionsThe options to use when performing the highlight. If there is no highlight style specified, an exception will be thrown.
in_verticesAn array of vertex indices, specifying vertices to highlight.
in_edges1An array of vertex indices, which when paired with the corresponding entries in the in_edges2 array, define a list of edges to highlight.
in_edges2An array of vertex indices to be paired with entries in in_edges1 array to define the edge list.
in_facesAn array of faces indices specifying faces to highlight.
Returns
    A reference to this HighlightControl.
override HPS.Type HPS.HighlightControl.ObjectType ( )
inlinevirtual

This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.

Returns
    The declared type of the object in question, which may differ from the true, underlying type.

Reimplemented from HPS.Control.

override HPS.Type HPS.HighlightControl.Type ( )
inlinevirtual

This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types.

Returns
    The true type of the object in question.

Reimplemented from HPS.Control.

HPS.HighlightControl HPS.HighlightControl.Unhighlight ( HPS.SelectionResults  in_items,
HPS.HighlightOptionsKit  in_options 
)
inline

Unhighlight the specified selection results by removing the specified highlight options.

Parameters
in_itemsThe selection results to unhighlight. If there are invalid selection items in the selection results, an exception will be thrown.
in_optionsThe highlight options to be removed. Defaults to an empty HighlightOptionsKit.
Returns
    A reference to this HighlightControl.
HPS.HighlightControl HPS.HighlightControl.Unhighlight ( HPS.SelectionResults  in_items)
inline

Unhighlight the specified selection results by removing the specified highlight options.

Parameters
in_itemsThe selection results to unhighlight. If there are invalid selection items in the selection results, an exception will be thrown.
Returns
    A reference to this HighlightControl.
HPS.HighlightControl HPS.HighlightControl.Unhighlight ( HPS.SelectionItem  in_item,
HPS.HighlightOptionsKit  in_options 
)
inline

Unhighlight the specified selection item by removing the specified highlight options.

Parameters
in_itemThe selection item to unhighlight. If the selection item is invalid, an exception will be thrown.
in_optionsThe highlight options to be removed. Defaults to an empty HighlightOptionsKit.
Returns
    A reference to this HighlightControl.
HPS.HighlightControl HPS.HighlightControl.Unhighlight ( HPS.SelectionItem  in_item)
inline

Unhighlight the specified selection item by removing the specified highlight options.

Parameters
in_itemThe selection item to unhighlight. If the selection item is invalid, an exception will be thrown.
Returns
    A reference to this HighlightControl.
HPS.HighlightControl HPS.HighlightControl.Unhighlight ( HPS.SearchResults  in_items,
HPS.HighlightOptionsKit  in_options 
)
inline

Unhighlight the specified search results by removing the specified highlight options.

Parameters
in_itemsThe search results to unhighlight. If there are invalid keys in the search results, an exception will be thrown.
in_optionsThe highlight options to be removed. Defaults to an empty HighlightOptionsKit.
Returns
    A reference to this HighlightControl.
HPS.HighlightControl HPS.HighlightControl.Unhighlight ( HPS.SearchResults  in_items)
inline

Unhighlight the specified search results by removing the specified highlight options.

Parameters
in_itemsThe search results to unhighlight. If there are invalid keys in the search results, an exception will be thrown.
Returns
    A reference to this HighlightControl.
HPS.HighlightControl HPS.HighlightControl.Unhighlight ( HPS.KeyPath  in_item,
HPS.HighlightOptionsKit  in_options 
)
inline

Unhighlight the specified key path by removing the specified highlight options.

Parameters
in_itemThe key path to unhighlight. If there are no keys or invalid keys in the key path, an exception will be thrown.
in_optionsThe highlight options to be removed. Defaults to an empty HighlightOptionsKit.
Returns
    A reference to this HighlightControl.
HPS.HighlightControl HPS.HighlightControl.Unhighlight ( HPS.KeyPath  in_item)
inline

Unhighlight the specified key path by removing the specified highlight options.

Parameters
in_itemThe key path to unhighlight. If there are no keys or invalid keys in the key path, an exception will be thrown.
Returns
    A reference to this HighlightControl.
HPS.HighlightControl HPS.HighlightControl.Unhighlight ( HPS.Key  in_item,
HPS.HighlightOptionsKit  in_options 
)
inline

Unhighlight the specified key by removing the specified highlight options.

Parameters
in_itemThe key to unhighlight. If the key is invalid, an exception will be thrown..
in_optionsThe highlight options to be removed. Defaults to an empty HighlightOptionsKit.
Returns
    A reference to this HighlightControl.
HPS.HighlightControl HPS.HighlightControl.Unhighlight ( HPS.Key  in_item)
inline

Unhighlight the specified key by removing the specified highlight options.

Parameters
in_itemThe key to unhighlight. If the key is invalid, an exception will be thrown..
Returns
    A reference to this HighlightControl.
HPS.HighlightControl HPS.HighlightControl.Unhighlight ( HPS.KeyPath  in_item,
HPS.HighlightOptionsKit  in_options,
ulong[]  in_vertices,
ulong[]  in_edges1,
ulong[]  in_edges2,
ulong[]  in_faces 
)
inline

Unhighlight subentities from the specified key path by removing the specified highlight options.

Parameters
in_itemThe key path to unhighlight. If there are no keys or invalid keys in the key path, an exception will be thrown.
in_optionsThe highlight options to be removed. Defaults to an empty HighlightOptionsKit.
in_verticesAn array of vertex indices, specifying vertices to unhighlight.
in_edges1An array of vertex indices, which when paired with the corresponding entries in the in_edges2 array, define a list of edges to unhighlight.
in_edges2An array of vertex indices to be paired with entries in in_edges1 array to define the edge list.
in_facesAn array of faces indices specifying faces to unhighlight.
Returns
    A reference to this HighlightControl.
HPS.HighlightControl HPS.HighlightControl.Unhighlight ( HPS.Key  in_item,
HPS.HighlightOptionsKit  in_options,
ulong[]  in_vertices,
ulong[]  in_edges1,
ulong[]  in_edges2,
ulong[]  in_faces 
)
inline

Unhighlight subentities from the specified item by removing the specified highlight options.

Parameters
in_itemThe key to unhighlight. If the key is invalid, an exception will be thrown..
in_optionsThe highlight options to be removed. Defaults to an empty HighlightOptionsKit.
in_verticesAn array of vertex indices, specifying vertices to unhighlight.
in_edges1An array of vertex indices, which when paired with the corresponding entries in the in_edges2 array, define a list of edges to unhighlight.
in_edges2An array of vertex indices to be paired with entries in in_edges1 array to define the edge list.
in_facesAn array of faces indices specifying faces to unhighlight.
Returns
    A reference to this HighlightControl.
HPS.HighlightControl HPS.HighlightControl.Unhighlight ( HPS.HighlightOptionsKit  in_options)
inline

Unhighlight geometry which was highlighted with the specified HighlightOptionsKit.

Parameters
in_optionsThe highlight options to be removed.
Returns
    A reference to this HighlightControl.
HPS.HighlightControl HPS.HighlightControl.UnhighlightEverything ( )
inline

Unhighlight everything in the window associated with this HighlightControl.

Returns
    A reference to this HighlightControl.

The documentation for this class was generated from the following file:
  • internals/hps_core/source/cs/HPS.HighlightControl.cs