REFERENCE MANUAL
The navigationCubeControl allows you to turn on or off the navigation cube, move it to a specific corner of the screen, change the material palette used to style it, or otherwise manipulate it. More...
Public Types | |
enum | Location { Location.TopRight = 0, Location.TopLeft = 1, Location.BottomRight = 2, Location.BottomLeft = 3 } |
![]() | |
enum | UpdateType { Synchronous = 0, Asynchronous = 1 } |
Public Member Functions | |
override void | Dispose () |
bool | GetInteractivity () |
Gets the interactivity of this navigation cube. More... | |
HPS.NavigationCubeControl.Location | GetLocation () |
Gets the location of the navigation cube. More... | |
string | GetMaterialPalette () |
Gets the material palette used for this navigation cube. More... | |
HPS.SegmentKey | GetSegmentKey () |
Gets the segment where this navigation cube resides. More... | |
bool | GetTextVisibility () |
Gets the text visibility of the navigation cube. More... | |
bool | GetVisibility () |
Gets the visibility of the navigation cube. More... | |
NavigationCubeControl (HPS.View in_view) | |
Initializes a control tied to the view in_view. More... | |
NavigationCubeControl (HPS.NavigationCubeControl in_that) | |
Initializes a control tied to the same object as in_that. More... | |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. More... | |
HPS.NavigationCubeControl | SetInteractivity (bool in_interactivity) |
Sets the interactivity of this navigation cube. More... | |
HPS.NavigationCubeControl | SetLocation (HPS.NavigationCubeControl.Location in_location) |
Sets the location of this navigation cube. More... | |
HPS.NavigationCubeControl | SetMaterialPalette (string in_material_palette) |
Sets the material palette of this navigation cube. More... | |
HPS.NavigationCubeControl | SetTextVisibility (bool in_text_visibility) |
Sets the text visibility of this navigation cube. More... | |
HPS.NavigationCubeControl | SetVisibility (bool in_visibility) |
Sets the visibility of this navigation cube. More... | |
![]() | |
override void | Dispose () |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. More... | |
SprocketControl (HPS.SprocketControl in_that) | |
![]() | |
Sprocket (HPS.Sprocket in_that) | |
![]() | |
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. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object in_that) | |
The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More... | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
HPS.Type | Type () |
This function returns the true type of the underlying object. More... | |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
static IntPtr | ClassID< T > () |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
HandleRef | scptr |
The navigationCubeControl allows you to turn on or off the navigation cube, move it to a specific corner of the screen, change the material palette used to style it, or otherwise manipulate it.
HPS.NavigationCubeControl.NavigationCubeControl | ( | HPS.View | in_view | ) |
Initializes a control tied to the view in_view.
HPS.NavigationCubeControl.NavigationCubeControl | ( | HPS.NavigationCubeControl | in_that | ) |
Initializes a control tied to the same object as in_that.
bool HPS.NavigationCubeControl.GetInteractivity | ( | ) |
Gets the interactivity of this navigation cube.
HPS.NavigationCubeControl.Location HPS.NavigationCubeControl.GetLocation | ( | ) |
Gets the location of the navigation cube.
string HPS.NavigationCubeControl.GetMaterialPalette | ( | ) |
Gets the material palette used for this navigation cube.
HPS.SegmentKey HPS.NavigationCubeControl.GetSegmentKey | ( | ) |
Gets the segment where this navigation cube resides.
bool HPS.NavigationCubeControl.GetTextVisibility | ( | ) |
Gets the text visibility of the navigation cube.
bool HPS.NavigationCubeControl.GetVisibility | ( | ) |
Gets the visibility of the navigation cube.
|
virtual |
This function returns the type the object, as declared.
This does not necessarily give the true type of the underlying object.
Reimplemented from HPS.Object.
HPS.NavigationCubeControl HPS.NavigationCubeControl.SetInteractivity | ( | bool | in_interactivity | ) |
Sets the interactivity of this navigation cube.
When the navigation cube is interactive, dragging the triad will rotate the scene and clicking on a face, edge or vertex of the cube will snap the camera to the appropriate plane. Making the Navigation Cube interactive pushes the Navigation Cube operator on the current View's operator stack with High priority
in_interactivity | the interactivity of this navigation cube |
HPS.NavigationCubeControl HPS.NavigationCubeControl.SetLocation | ( | HPS.NavigationCubeControl.Location | in_location | ) |
Sets the location of this navigation cube.
in_location | the location of this navigation cube |
HPS.NavigationCubeControl HPS.NavigationCubeControl.SetMaterialPalette | ( | string | in_material_palette | ) |
Sets the material palette of this navigation cube.
The material palette supplied to this function should originate from a material kit array with 9 entries. The entries in the material kit array are applied to the navigation cube as follows: Entry 0 - back face color Entry 1 - top face color Entry 2 - left face color Entry 3 - front face color Entry 4 - bottom face color Entry 5 - right face color Entry 6 - mouse-over highlight color Entry 7 - text color Entry 8 - line color
in_material_palette | the name of the material palette to be used for this navigation cube |
HPS.NavigationCubeControl HPS.NavigationCubeControl.SetTextVisibility | ( | bool | in_text_visibility | ) |
Sets the text visibility of this navigation cube.
in_text_visibility | the visibility of the text for this navigation cube |
HPS.NavigationCubeControl HPS.NavigationCubeControl.SetVisibility | ( | bool | in_visibility | ) |
Sets the visibility of this navigation cube.
in_visibility | the visibility of this navigation cube |