# AxisTriadControl

class `AxisTriadControl` : public HPS::SprocketControl

  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.

  Public Types

  enum class `Location`

    Values:

    enumerator `TopRight`

      Position Axis Triad on the top right corner.

    enumerator `TopLeft`

      Position Axis Triad on the top left corner.

    enumerator `BottomRight`

      Position Axis Triad on the bottom right corner.

    enumerator `BottomLeft`

      Position Axis Triad on the bottom left corner.

    enumerator `Custom`

      Position Axis Triad at a custom location.

  Public Functions

  `AxisTriadControl`(AxisTriadControl &&in_that)

    The move constructor creates a AxisTriadControl by transferring the underlying impl of the rvalue reference to this AxisTriadControl thereby avoiding a copy and allocation.

    Parameters: | in_that – An rvalue reference to a AxisTriadControl to take the impl from.

  `AxisTriadControl`(AxisTriadControl const &in_that)

    Initializes a control tied to the same object as in_that.

  explicit `AxisTriadControl`(View const &in_view)

    Initializes a control tied to the view in_view.

  bool `GetInteractivity`() const

    Gets the interactivity of this axis triad.

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

  Location `GetLocation`() const

    Gets the location of the axis triad.

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

  HPS::UTF8 `GetMaterialPalette`() const

    Gets the material palette used for this axis triad.

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

  HPS::Rectangle `GetPosition`() const

    Gets the position of the subwindow containing the axis triad.

    Returns: | The position of the subwindow containing the axis triad.

  HPS::IntRectangle `GetPositionOffsets`() const

    Gets the position of the subwindow containing the axis triad.

    Returns: | The offset to the position of the subwindow containing the axis triad.

  HPS::SegmentKey `GetSegmentKey`() const

    Gets the segment where this axis triad resides.

    Returns: | The segment key associated with this axis triad.

  float `GetSize`() const

    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.

  bool `GetTextVisibility`() const

    Gets the text visibility of the axis triad.

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

  bool `GetVisibility`() const

    Gets the visibility of the axis triad.

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

  inline virtual HPS::Type `ObjectType`() const

    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.

  AxisTriadControl &`operator=`(AxisTriadControl &&in_that)

    The move assignment operator transfers the underlying impl of the rvalue reference to this AxisTriadControl thereby avoiding a copy.

    Parameters: | in_that – An rvalue reference to a AxisTriadControl to take the impl from.
    Returns: | A reference to this AxisTriadControl.

  AxisTriadControl &`operator=`(AxisTriadControl const &in_that)

    Share the smart-pointer.

  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_interactivity – the interactivity of this axis triad
    Returns: | A reference to this object. By default the axis triad is not interactive.

  HPS::AxisTriadControl &`SetLocation`(Location in_location, HPS::Rectangle const &in_position = HPS::Rectangle(), HPS::IntRectangle in_offsets = HPS::IntRectangle::Zero())

    Sets the location of this axis triad.

    Parameters: | in_location – the location of this axis triad in_position – the position of the subwindow containing the axis triad. only used when in_location is Custom in_offsets – the 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

  HPS::AxisTriadControl &`SetMaterialPalette`(char const *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_palette – the name of the material palette to be used for this axis triad
    Returns: | A reference to this object.

  AxisTriadControl &`SetPosition`(HPS::Rectangle const &in_position)

    Sets the position of the subwindow containing the axis triad.

    Parameters: | in_position – a rectangle describing the subwindow containing the axis triad.
    Returns: | A reference to this object.

  AxisTriadControl &`SetPositionOffsets`(HPS::IntRectangle const &in_offsets)

    Sets the position of the subwindow containing this axis triad.

    Parameters: | in_offsets – a rectangle describing the offsets being applied to the current position
    Returns: | A reference to this object.

  AxisTriadControl &`SetSize`(float in_size)

    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

  HPS::AxisTriadControl &`SetTextVisibility`(bool in_text_visibility)

    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.

  HPS::AxisTriadControl &`SetVisibility`(bool in_visibility)

    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

  `~AxisTriadControl`()

    Releases a reference to the database object this control is tied to.

  Public Static Attributes

  static const HPS::Type `staticType` = HPS::Type::AxisTriadControl

Hello I'm HOOPSY!

HOOPSY BETA

Hello I am HOOPSY! your Docs generative AI assistant.

Ask me anything about HOOPS Visualize HPS or choose a sample question below to start a conversation:

Additional info

HOOPSY may store chats to provide and maintain the service according to OpenAI's data policy.

This feature is currently experimental. While we are continually enhancing its performance and quality, the underlying AI model may generate inaccurate or fabricated responses, especially if prompted to do so.

New Conversation
Continue generating