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

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) | |
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.Rectangle | GetPosition () |
Gets the poition of the subwindow containing the axis triad. More... | |
HPS.SegmentKey | GetSegmentKey () |
Gets the segment where this axis triad resides. More... | |
float | GetSize () |
Gets the size of the subwindow containing the axis triad, as a percentage of the main window. 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. This does not necessarily give the true type of the underlying object. More... | |
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 More... | |
HPS.AxisTriadControl | SetLocation (HPS.AxisTriadControl.Location in_location, HPS.Rectangle in_rectangle) |
Sets the location 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. 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 More... | |
HPS.AxisTriadControl | SetPosition (HPS.Rectangle in_rectangle) |
Sets the position of the subwindow containing this axis triad. More... | |
HPS.AxisTriadControl | SetSize (float in_size) |
Sets the size of the subwindow containing the axis triad, as a percentage of the main window. 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... | |
![]() | |
override void | Dispose () |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying 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 an identifier that can be used to identify which instance of a class an object is. 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... | |
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 |
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
Constructor & Destructor Documentation
|
inline |
Initializes a control tied to the view in_view.
|
inline |
Initializes a control tied to the same object as in_that.
Member Function Documentation
|
inline |
Gets the interactivity of this axis triad.
- Returns
- true if the axis triad is interactive, false otherwise.
|
inline |
Gets the location of the axis triad.
- Returns
- The location of the axis triad relative to the view.
|
inline |
Gets the material palette used for this axis triad.
- Returns
- The name of the material palette used for this axis triad.
|
inline |
Gets the poition of the subwindow containing the axis triad.
- Returns
- The position of the subwindow containing the axis triad.
|
inline |
Gets the segment where this axis triad resides.
- Returns
- The segment key associated with this axis triad.
|
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.
|
inline |
Gets the text visibility of the axis triad.
- Returns
- true if the axis triad text is visible, false otherwise.
|
inline |
Gets the visibility of the axis triad.
- Returns
- true if the axis triad is visible, false otherwise.
|
inlinevirtual |
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.
|
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_interactivity the interactivity of this axis triad
- Returns
- A reference to this object. By default the axis triad is not interactive.
|
inline |
Sets the location of this axis triad.
- Parameters
-
in_location the location of this axis triad in_rectangle the 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
|
inline |
Sets the location of this axis triad.
- Parameters
-
in_location the 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
|
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_palette the name of the material palette to be used for this axis triad
- Returns
- A reference to this object.
|
inline |
Sets the position of the subwindow containing this axis triad.
- Parameters
-
in_rectangle a rectangle describing the subwindow containing the axis triad
- Returns
- A reference to this object.
|
inline |
Sets the size of the subwindow containing the axis triad, as a percentage of the main window.
- Parameters
-
in_size The 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
|
inline |
Sets the text visibility of this axis triad.
- Parameters
-
in_text_visibility the visibility of the text for this axis triad
- Returns
- A reference to this object.
|
inline |
Sets the visibility of this axis triad.
- Parameters
-
in_visibility the 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