< Home

< Table of Contents

REFERENCE MANUAL

HPS.NavigationCubeControl Class Reference

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...

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 }
 
- Public Types inherited from HPS.Sprocket
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...
 
- Public Member Functions inherited from HPS.SprocketControl
override void Dispose ()
 
override HPS.Type ObjectType ()
 This function returns the type the object, as declared. More...
 
 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 ()
 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 ()
 
- 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
 
HandleRef scptr
 

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.

Member Enumeration Documentation

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.

Constructor & Destructor Documentation

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.

Member Function Documentation

bool HPS.NavigationCubeControl.GetInteractivity ( )

Gets the interactivity of this navigation cube.

Returns
true if the navigation cube is interactive, false otherwise.
HPS.NavigationCubeControl.Location HPS.NavigationCubeControl.GetLocation ( )

Gets the location of the navigation cube.

Returns
The location of the navigation cube relative to the view.
string HPS.NavigationCubeControl.GetMaterialPalette ( )

Gets the material palette used for this navigation cube.

Returns
The name of the material palette used for this navigation cube.
HPS.SegmentKey HPS.NavigationCubeControl.GetSegmentKey ( )

Gets the segment where this navigation cube resides.

Returns
The segment key associated with this navigation cube.
bool HPS.NavigationCubeControl.GetTextVisibility ( )

Gets the text visibility of the navigation cube.

Returns
true if the text on the navigation cube is visible, false otherwise.
bool HPS.NavigationCubeControl.GetVisibility ( )

Gets the visibility of the navigation cube.

Returns
true if the navigation cube is visible, false otherwise.
override HPS.Type HPS.NavigationCubeControl.ObjectType ( )
virtual

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.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

Parameters
in_interactivitythe interactivity of this navigation cube
Returns
A reference to this object. By default the navigation cube is not interactive
HPS.NavigationCubeControl HPS.NavigationCubeControl.SetLocation ( HPS.NavigationCubeControl.Location  in_location)

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

Parameters
in_material_palettethe name of the material palette to be used for this navigation cube
Returns
A reference to this object.
HPS.NavigationCubeControl HPS.NavigationCubeControl.SetTextVisibility ( bool  in_text_visibility)

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.
HPS.NavigationCubeControl HPS.NavigationCubeControl.SetVisibility ( bool  in_visibility)

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: