< Home

< Table of Contents

REFERENCE MANUAL

HPS.AxisTriadControl Class Reference

The AxisTriadControl allows you to turn on or off the axis triad, 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.AxisTriadControl:
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

 AxisTriadControl (HPS.View in_view)
 Initializes a control tied to the view in_view. More...
 
 AxisTriadControl (HPS.AxisTriadControl in_that)
 Initializes a control tied to the same object as in_that. More...
 
override void Dispose ()
 
bool GetInteractivity ()
 Gets the interactivity of this axis triad. More...
 
HPS.AxisTriadControl.Location GetLocation ()
 Gets the location of the axis triad. More...
 
string GetMaterialPalette ()
 Gets the material palette used for this axis triad. More...
 
HPS.SegmentKey GetSegmentKey ()
 Gets the segment where this axis triad resides. More...
 
bool GetTextVisibility ()
 Gets the text visibility of the axis triad. More...
 
bool GetVisibility ()
 Gets the visibility of the axis triad. More...
 
override HPS.Type ObjectType ()
 This function returns the type the object, as declared. More...
 
HPS.AxisTriadControl SetInteractivity (bool in_interactivity)
 Sets the interactivity of this axis triad. More...
 
HPS.AxisTriadControl SetLocation (HPS.AxisTriadControl.Location in_location)
 Sets the location of this axis triad. More...
 
HPS.AxisTriadControl SetMaterialPalette (string in_material_palette)
 Sets the material palette of this axis triad. More...
 
HPS.AxisTriadControl SetTextVisibility (bool in_text_visibility)
 Sets the text visibility of this axis triad. More...
 
HPS.AxisTriadControl SetVisibility (bool in_visibility)
 Sets the visibility of this axis triad. 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 AxisTriadControl allows you to turn on or off the axis triad, 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 Axis Triad on the top right corner.

TopLeft 

Position Axis Triad on the top left corner.

BottomRight 

Position Axis Triad on the bottom right corner.

BottomLeft 

Position Axis Triad on the bottom left corner.

Constructor & Destructor Documentation

HPS.AxisTriadControl.AxisTriadControl ( HPS.View  in_view)

Initializes a control tied to the view in_view.

HPS.AxisTriadControl.AxisTriadControl ( HPS.AxisTriadControl  in_that)

Initializes a control tied to the same object as in_that.

Member Function Documentation

bool HPS.AxisTriadControl.GetInteractivity ( )

Gets the interactivity of this axis triad.

Returns
true if the axis triad is interactive, false otherwise.
HPS.AxisTriadControl.Location HPS.AxisTriadControl.GetLocation ( )

Gets the location of the axis triad.

Returns
The location of the axis triad relative to the view.
string HPS.AxisTriadControl.GetMaterialPalette ( )

Gets the material palette used for this axis triad.

Returns
The name of the material palette used for this axis triad.
HPS.SegmentKey HPS.AxisTriadControl.GetSegmentKey ( )

Gets the segment where this axis triad resides.

Returns
The segment key associated with this axis triad.
bool HPS.AxisTriadControl.GetTextVisibility ( )

Gets the text visibility of the axis triad.

Returns
true if the axis triad text is visible, false otherwise.
bool HPS.AxisTriadControl.GetVisibility ( )

Gets the visibility of the axis triad.

Returns
true if the axis triad is visible, false otherwise.
override HPS.Type HPS.AxisTriadControl.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.AxisTriadControl HPS.AxisTriadControl.SetInteractivity ( bool  in_interactivity)

Sets the interactivity of this axis triad.

When the axis triad is interactive, dragging the triad will rotate the scene. Making the Axis Triad interactive pushes the Axis Triad operator on the current View's operator stack with High priority

Parameters
in_interactivitythe interactivity of this axis triad
Returns
A reference to this object. By default the axis triad is not interactive.
HPS.AxisTriadControl HPS.AxisTriadControl.SetLocation ( HPS.AxisTriadControl.Location  in_location)

Sets the location of this axis triad.

Parameters
in_locationthe location of this axis triad
Returns
A reference to this object. By default the axis triad is placed on the bottom left corner of the View
HPS.AxisTriadControl HPS.AxisTriadControl.SetMaterialPalette ( string  in_material_palette)

Sets the material palette of this axis triad.

The material palette supplied to this function should originate from a material kit array with 3 entries. The entries in the material kit array are applied to the navigation cube as follows: Entry 0 - x-axis color Entry 1 - y-axis color Entry 2 - z-axis color

Parameters
in_material_palettethe name of the material palette to be used for this axis triad
Returns
A reference to this object.
HPS.AxisTriadControl HPS.AxisTriadControl.SetTextVisibility ( bool  in_text_visibility)

Sets the text visibility of this axis triad.

Parameters
in_text_visibilitythe visibility of the text for this axis triad
Returns
A reference to this object.
HPS.AxisTriadControl HPS.AxisTriadControl.SetVisibility ( bool  in_visibility)

Sets the visibility of this axis triad.

Parameters
in_visibilitythe visibility of this axis triad
Returns
A reference to this object. By default the axis triad is not visible

The documentation for this class was generated from the following file: