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,
  Location.Custom = 4
}


 

Public Member Functions

 AxisTriadControl (HPS.View in_view)
 
 AxisTriadControl (HPS.AxisTriadControl in_that)
 
override void Dispose ()
 
bool GetInteractivity ()
 
HPS.AxisTriadControl.Location GetLocation ()
 
string GetMaterialPalette ()
 
HPS.Rectangle GetPosition ()
 
HPS.IntRectangle GetPositionOffsets ()
 
HPS.SegmentKey GetSegmentKey ()
 
float GetSize ()
 
bool GetTextVisibility ()
 
bool GetVisibility ()
 
override HPS.Type ObjectType ()
 
HPS.AxisTriadControl SetInteractivity (bool in_interactivity)
 
HPS.AxisTriadControl SetLocation (HPS.AxisTriadControl.Location in_location, HPS.Rectangle in_position, HPS.IntRectangle in_offsets)
 
HPS.AxisTriadControl SetLocation (HPS.AxisTriadControl.Location in_location, HPS.Rectangle in_position)
 
HPS.AxisTriadControl SetLocation (HPS.AxisTriadControl.Location in_location)
 
HPS.AxisTriadControl SetMaterialPalette (string in_material_palette)
 
HPS.AxisTriadControl SetPosition (HPS.Rectangle in_position)
 
HPS.AxisTriadControl SetPositionOffsets (HPS.IntRectangle in_offsets)
 
HPS.AxisTriadControl SetSize (float in_size)
 
HPS.AxisTriadControl SetTextVisibility (bool in_text_visibility)
 
HPS.AxisTriadControl 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 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

◆ Location

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.

Custom 

Position Axis Triad at a custom location.

Constructor & Destructor Documentation

◆ AxisTriadControl() [1/2]

HPS.AxisTriadControl.AxisTriadControl ( HPS.View  in_view)
inline

Initializes a control tied to the view in_view.

◆ AxisTriadControl() [2/2]

HPS.AxisTriadControl.AxisTriadControl ( HPS.AxisTriadControl  in_that)
inline

Initializes a control tied to the same object as in_that.

Member Function Documentation

◆ GetInteractivity()

bool HPS.AxisTriadControl.GetInteractivity ( )
inline

Gets the interactivity of this axis triad.

Returns
true if the axis triad is interactive, false otherwise.

◆ GetLocation()

HPS.AxisTriadControl.Location HPS.AxisTriadControl.GetLocation ( )
inline

Gets the location of the axis triad.

Returns
The location of the axis triad relative to the view.

◆ GetMaterialPalette()

string HPS.AxisTriadControl.GetMaterialPalette ( )
inline

Gets the material palette used for this axis triad.

Returns
The name of the material palette used for this axis triad.

◆ GetPosition()

HPS.Rectangle HPS.AxisTriadControl.GetPosition ( )
inline

Gets the position of the subwindow containing the axis triad.

Returns
The position of the subwindow containing the axis triad.

◆ GetPositionOffsets()

HPS.IntRectangle HPS.AxisTriadControl.GetPositionOffsets ( )
inline

Gets the poition of the subwindow containing the axis triad.

Returns
The position of the subwindow containing the axis triad.

◆ GetSegmentKey()

HPS.SegmentKey HPS.AxisTriadControl.GetSegmentKey ( )
inline

Gets the segment where this axis triad resides.

Returns
The segment key associated with this axis triad.

◆ GetSize()

float HPS.AxisTriadControl.GetSize ( )
inline

Gets the size of the subwindow containing the axis triad, as a percentage of the main window.

Returns
the size of the subwindow containing the axis triad, as a percentage of the main window. If the location is Custom, this will return -1.0f.

◆ GetTextVisibility()

bool HPS.AxisTriadControl.GetTextVisibility ( )
inline

Gets the text visibility of the axis triad.

Returns
true if the axis triad text is visible, false otherwise.

◆ GetVisibility()

bool HPS.AxisTriadControl.GetVisibility ( )
inline

Gets the visibility of the axis triad.

Returns
true if the axis triad is visible, false otherwise.

◆ ObjectType()

override HPS.Type HPS.AxisTriadControl.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.AxisTriadControl HPS.AxisTriadControl.SetInteractivity ( bool  in_interactivity)
inline

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.

◆ SetLocation() [1/3]

HPS.AxisTriadControl HPS.AxisTriadControl.SetLocation ( HPS.AxisTriadControl.Location  in_location,
HPS.Rectangle  in_position,
HPS.IntRectangle  in_offsets 
)
inline

Sets the location of this axis triad.

Parameters
in_locationthe location of this axis triad
in_positionthe position of the subwindow containing the axis triad. only used when in_location is 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 axis triad is placed on the bottom left corner of the View

◆ SetLocation() [2/3]

HPS.AxisTriadControl HPS.AxisTriadControl.SetLocation ( HPS.AxisTriadControl.Location  in_location,
HPS.Rectangle  in_position 
)
inline

Sets the location of this axis triad.

Parameters
in_locationthe location of this axis triad
in_positionthe position of the subwindow containing the axis triad. only used when in_location is Custom
Returns
A reference to this object. By default the axis triad is placed on the bottom left corner of the View

◆ SetLocation() [3/3]

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

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

◆ SetMaterialPalette()

HPS.AxisTriadControl HPS.AxisTriadControl.SetMaterialPalette ( string  in_material_palette)
inline

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.

◆ SetPosition()

HPS.AxisTriadControl HPS.AxisTriadControl.SetPosition ( HPS.Rectangle  in_position)
inline

Sets the position of the subwindow containing the axis triad.

Parameters
in_positiona rectangle describing the subwindow containing the axis triad.
Returns
A reference to this object.

◆ SetPositionOffsets()

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

Sets the position of the subwindow containing this axis triad.

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

◆ SetSize()

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

Sets the size of the subwindow containing the axis triad, as a percentage of the main window.

Parameters
in_sizeThe size of the subwindow containing the axis triad, as a percentage of the main window. [0-1]
Returns
A reference to this object. By default the axis triad subwindow is 20% of the main window

◆ SetTextVisibility()

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

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.

◆ SetVisibility()

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

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:
  • internals/hps_sprk/source/cs/HPS.AxisTriadControl.cs