
Public Types | |
enum | Location { Location.TopRight = 0, Location.TopLeft = 1, Location.BottomRight = 2, Location.BottomLeft = 3, Location.Custom = 4 } |
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.Rectangle | GetPosition () |
Gets the poition of the subwindow containing the navigation cube. More... | |
HPS.IntRectangle | GetPositionOffsets () |
Gets the poition of the subwindow containing the navigation cube. More... | |
HPS.SegmentKey | GetSegmentKey () |
Gets the segment where this navigation cube resides. More... | |
float | GetSize () |
Gets the size of the subwindow containing the navigation cube, as a percentage of the main window. More... | |
bool | GetText (out string out_back_string, out string out_top_string, out string out_left_string, out string out_front_string, out string out_bottom_string, out string out_right_string, out HPS.TextAttributeKit out_text_attributes) |
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 (if the object is derived, this does not give the true type of the derived object). More... | |
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 More... | |
HPS.NavigationCubeControl | SetLocation (HPS.NavigationCubeControl.Location in_location, HPS.Rectangle in_rectangle, HPS.IntRectangle in_offsets) |
Sets the location of this navigation cube. More... | |
HPS.NavigationCubeControl | SetLocation (HPS.NavigationCubeControl.Location in_location, HPS.Rectangle in_rectangle) |
Sets the location 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. 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 More... | |
HPS.NavigationCubeControl | SetPosition (HPS.Rectangle in_rectangle) |
Sets the position of the subwindow containing this navigation cube. More... | |
HPS.NavigationCubeControl | SetPositionOffsets (HPS.IntRectangle in_offsets) |
Sets the position of the subwindow containing the navigation cube. More... | |
HPS.NavigationCubeControl | SetSize (float in_size) |
Sets the size of the subwindow containing the navigation cube, as a percentage of the main window. More... | |
HPS.NavigationCubeControl | SetText (string in_back_string, string in_top_string, string in_left_string, string in_front_string, string in_bottom_string, string in_right_string, HPS.TextAttributeKit in_text_attributes) |
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 (if the object is derived, this does not give the true type of the derived object). 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 the object's database handle, which can be used to determine which instance of a class the object is. For example, controls are simply aliases for segment keys that group related functions. Therefore, a SegmentKey and all of its controls would return the same instance id. 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... | |
virtual 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... | |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
static IntPtr | ClassID< T > () |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
Detailed Description
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. To allow your users to interact with the Navigation Cube, see HPS.NavigationCubeOperator.
- Note
The orientation of the NavigationCubeControl is specified by the model in the associated view. See HPS.Model.SetOrientation().
Member Enumeration Documentation
◆ Location
|
strong |
Constructor & Destructor Documentation
◆ NavigationCubeControl() [1/2]
|
inline |
Initializes a control tied to the view in_view.
◆ NavigationCubeControl() [2/2]
|
inline |
Initializes a control tied to the same object as in_that.
Member Function Documentation
◆ GetInteractivity()
|
inline |
Gets the interactivity of this navigation cube.
- Returns
- true if the navigation cube is interactive, false otherwise.
◆ GetLocation()
|
inline |
Gets the location of the navigation cube.
- Returns
- The location of the navigation cube relative to the view.
◆ GetMaterialPalette()
|
inline |
Gets the material palette used for this navigation cube.
- Returns
- The name of the material palette used for this navigation cube.
◆ GetPosition()
|
inline |
Gets the poition of the subwindow containing the navigation cube.
- Returns
- The position of the subwindow containing the navigation cube.
◆ GetPositionOffsets()
|
inline |
Gets the poition of the subwindow containing the navigation cube.
- Returns
- The position of the subwindow containing the navigation cube.
◆ GetSegmentKey()
|
inline |
Gets the segment where this navigation cube resides.
- Returns
- The segment key associated with this navigation cube.
◆ GetSize()
|
inline |
Gets the size of the subwindow containing the navigation cube, as a percentage of the main window.
- Returns
- the size of the subwindow containing the navigation cube, as a percentage of the main window. If the location is Custom, this will return -1.0f.
◆ GetTextVisibility()
|
inline |
Gets the text visibility of the navigation cube.
- Returns
- true if the text on the navigation cube is visible, false otherwise.
◆ GetVisibility()
|
inline |
Gets the visibility of the navigation cube.
- Returns
- true if the navigation cube is visible, false otherwise.
◆ ObjectType()
|
inlinevirtual |
This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).
- Returns
- The declared type of the object in question, which may differ from the true, underlying type.
Reimplemented from HPS.Object.
◆ SetInteractivity()
|
inline |
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
- Parameters
-
in_interactivity the interactivity of this navigation cube
- Returns
- A reference to this object. By default the navigation cube is not interactive
◆ SetLocation() [1/3]
|
inline |
Sets the location of this navigation cube.
- Parameters
-
in_location the location of this navigation cube in_rectangle the position of the subwindow containing the navigation cube. Only considered if in_location is set to Custom. in_offsets the pixel-space rectangle to offset to the given position. only used when in_location is Custom
- Returns
- A reference to this object. By default the navigation cube is set to the top right corner of the View
◆ SetLocation() [2/3]
|
inline |
Sets the location of this navigation cube.
- Parameters
-
in_location the location of this navigation cube in_rectangle the position of the subwindow containing the navigation cube. Only considered if in_location is set to Custom.
- Returns
- A reference to this object. By default the navigation cube is set to the top right corner of the View
◆ SetLocation() [3/3]
|
inline |
Sets the location of this navigation cube.
- Parameters
-
in_location the location of this navigation cube
- Returns
- A reference to this object. By default the navigation cube is set to the top right corner of the View
◆ SetMaterialPalette()
|
inline |
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
- Parameters
-
in_material_palette the name of the material palette to be used for this navigation cube
- Returns
- A reference to this object.
◆ SetPosition()
|
inline |
Sets the position of the subwindow containing this navigation cube.
- Parameters
-
in_rectangle a rectangle describing the subwindow containing the navigation cube
- Returns
- A reference to this object.
◆ SetPositionOffsets()
|
inline |
Sets the position of the subwindow containing the navigation cube.
- Parameters
-
in_offsets a rectangle describing the offsets being applied to the current position.
- Returns
- A reference to this object.
◆ SetSize()
|
inline |
Sets the size of the subwindow containing the navigation cube, as a percentage of the main window.
- Parameters
-
in_size The size of the subwindow containing the navigation cube, as a percentage of the main window. [0-1]
- Returns
- A reference to this object. By default the navigation cube subwindow is 20% of the main window
◆ SetTextVisibility()
|
inline |
Sets the text visibility of this navigation cube.
- Parameters
-
in_text_visibility the visibility of the text for this navigation cube
- Returns
- A reference to this object.
◆ SetVisibility()
|
inline |
Sets the visibility of this navigation cube.
- Parameters
-
in_visibility the visibility of this navigation cube
- Returns
- A reference to this object. By default the navigation cube is not visible
The documentation for this class was generated from the following file:
- internals/hps_sprk/source/cs/HPS.NavigationCubeControl.cs