Inheritance diagram for HPS.NavigationCubeControl:
HPS.SprocketControl HPS.Sprocket HPS.Object

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 ()
 
HPS.NavigationCubeControl.Location GetLocation ()
 
string GetMaterialPalette ()
 
HPS.Rectangle GetPosition ()
 
HPS.IntRectangle GetPositionOffsets ()
 
HPS.SegmentKey GetSegmentKey ()
 
float GetSize ()
 
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 ()
 
bool GetVisibility ()
 
 NavigationCubeControl (HPS.View in_view)
 
 NavigationCubeControl (HPS.NavigationCubeControl in_that)
 
override HPS.Type ObjectType ()
 
HPS.NavigationCubeControl SetInteractivity (bool in_interactivity)
 
HPS.NavigationCubeControl SetLocation (HPS.NavigationCubeControl.Location in_location, HPS.Rectangle in_rectangle, HPS.IntRectangle in_offsets)
 
HPS.NavigationCubeControl SetLocation (HPS.NavigationCubeControl.Location in_location, HPS.Rectangle in_rectangle)
 
HPS.NavigationCubeControl SetLocation (HPS.NavigationCubeControl.Location in_location)
 
HPS.NavigationCubeControl SetMaterialPalette (string in_material_palette)
 
HPS.NavigationCubeControl SetPosition (HPS.Rectangle in_rectangle)
 
HPS.NavigationCubeControl SetPositionOffsets (HPS.IntRectangle in_offsets)
 
HPS.NavigationCubeControl SetSize (float in_size)
 
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)
 
HPS.NavigationCubeControl SetVisibility (bool in_visibility)
 
- Public Member Functions inherited from HPS.SprocketControl
override void Dispose ()
 
override HPS.Type ObjectType ()
 
 SprocketControl (HPS.SprocketControl in_that)
 
- Public Member Functions inherited from HPS.Sprocket
 Sprocket (HPS.Sprocket in_that)
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
 Object (HPS.Object that)
 
virtual void Reset ()
 
virtual HPS.Type Type ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.SprocketControl
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 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

Enumerator
TopRight 

Position Navigation Cube on the top right corner.

TopLeft 

Position Navigation Cube on the top left corner.

BottomRight 

Position Navigation Cube on the bottom right corner.

BottomLeft 

Position Navigation Cube on the bottom left corner.

Custom 

Position Navigation Cube at a custom location.

Constructor & Destructor Documentation

◆ NavigationCubeControl() [1/2]

HPS.NavigationCubeControl.NavigationCubeControl ( HPS.View  in_view)
inline

Initializes a control tied to the view in_view.

◆ NavigationCubeControl() [2/2]

HPS.NavigationCubeControl.NavigationCubeControl ( HPS.NavigationCubeControl  in_that)
inline

Initializes a control tied to the same object as in_that.

Member Function Documentation

◆ GetInteractivity()

bool HPS.NavigationCubeControl.GetInteractivity ( )
inline

Gets the interactivity of this navigation cube.

Returns
true if the navigation cube is interactive, false otherwise.

◆ GetLocation()

HPS.NavigationCubeControl.Location HPS.NavigationCubeControl.GetLocation ( )
inline

Gets the location of the navigation cube.

Returns
The location of the navigation cube relative to the view.

◆ GetMaterialPalette()

string HPS.NavigationCubeControl.GetMaterialPalette ( )
inline

Gets the material palette used for this navigation cube.

Returns
The name of the material palette used for this navigation cube.

◆ GetPosition()

HPS.Rectangle HPS.NavigationCubeControl.GetPosition ( )
inline

Gets the poition of the subwindow containing the navigation cube.

Returns
The position of the subwindow containing the navigation cube.

◆ GetPositionOffsets()

HPS.IntRectangle HPS.NavigationCubeControl.GetPositionOffsets ( )
inline

Gets the poition of the subwindow containing the navigation cube.

Returns
The position of the subwindow containing the navigation cube.

◆ GetSegmentKey()

HPS.SegmentKey HPS.NavigationCubeControl.GetSegmentKey ( )
inline

Gets the segment where this navigation cube resides.

Returns
The segment key associated with this navigation cube.

◆ GetSize()

float HPS.NavigationCubeControl.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()

bool HPS.NavigationCubeControl.GetTextVisibility ( )
inline

Gets the text visibility of the navigation cube.

Returns
true if the text on the navigation cube is visible, false otherwise.

◆ GetVisibility()

bool HPS.NavigationCubeControl.GetVisibility ( )
inline

Gets the visibility of the navigation cube.

Returns
true if the navigation cube is visible, false otherwise.

◆ ObjectType()

override HPS.Type HPS.NavigationCubeControl.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()

HPS.NavigationCubeControl HPS.NavigationCubeControl.SetInteractivity ( bool  in_interactivity)
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_interactivitythe interactivity of this navigation cube
Returns
A reference to this object. By default the navigation cube is not interactive

◆ SetLocation() [1/3]

HPS.NavigationCubeControl HPS.NavigationCubeControl.SetLocation ( HPS.NavigationCubeControl.Location  in_location,
HPS.Rectangle  in_rectangle,
HPS.IntRectangle  in_offsets 
)
inline

Sets the location of this navigation cube.

Parameters
in_locationthe location of this navigation cube
in_rectanglethe position of the subwindow containing the navigation cube. Only considered if in_location is set to Custom.
in_offsetsthe 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]

HPS.NavigationCubeControl HPS.NavigationCubeControl.SetLocation ( HPS.NavigationCubeControl.Location  in_location,
HPS.Rectangle  in_rectangle 
)
inline

Sets the location of this navigation cube.

Parameters
in_locationthe location of this navigation cube
in_rectanglethe 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]

HPS.NavigationCubeControl HPS.NavigationCubeControl.SetLocation ( HPS.NavigationCubeControl.Location  in_location)
inline

Sets the location of this navigation cube.

Parameters
in_locationthe 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()

HPS.NavigationCubeControl HPS.NavigationCubeControl.SetMaterialPalette ( string  in_material_palette)
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_palettethe name of the material palette to be used for this navigation cube
Returns
A reference to this object.

◆ SetPosition()

HPS.NavigationCubeControl HPS.NavigationCubeControl.SetPosition ( HPS.Rectangle  in_rectangle)
inline

Sets the position of the subwindow containing this navigation cube.

Parameters
in_rectanglea rectangle describing the subwindow containing the navigation cube
Returns
A reference to this object.

◆ SetPositionOffsets()

HPS.NavigationCubeControl HPS.NavigationCubeControl.SetPositionOffsets ( HPS.IntRectangle  in_offsets)
inline

Sets the position of the subwindow containing the navigation cube.

Parameters
in_offsetsa rectangle describing the offsets being applied to the current position.
Returns
A reference to this object.

◆ SetSize()

HPS.NavigationCubeControl HPS.NavigationCubeControl.SetSize ( float  in_size)
inline

Sets the size of the subwindow containing the navigation cube, as a percentage of the main window.

Parameters
in_sizeThe 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()

HPS.NavigationCubeControl HPS.NavigationCubeControl.SetTextVisibility ( bool  in_text_visibility)
inline

Sets the text visibility of this navigation cube.

Parameters
in_text_visibilitythe visibility of the text for this navigation cube
Returns
A reference to this object.

◆ SetVisibility()

HPS.NavigationCubeControl HPS.NavigationCubeControl.SetVisibility ( bool  in_visibility)
inline

Sets the visibility of this navigation cube.

Parameters
in_visibilitythe 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