# BoundingKit

class `BoundingKit` : public HPS::Kit

  The HPS::BoundingKit class is a user space object, useful for carrying a group of attribute settings. Calling HPS::BoundingKit::GetDefault() will return a kit with values found in this table.

  Public Functions

  `BoundingKit`()

    Initializes an empty kit.

  `BoundingKit`(BoundingKit &&in_that)

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

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

  `BoundingKit`(BoundingKit const &in_kit)

    The copy constructor creates a new BoundingKit object that contains the same settings as the source object.

    Parameters: | in_kit – The source object to copy.

  virtual bool `Empty`() const

    Indicates whether this object has any values set on it.

    Returns: | true if no values are set on this object, false otherwise.

  bool `Equals`(BoundingKit const &in_kit) const

    Check if the source BoundingKit is equivalent to this object.

    Parameters: | in_kit – The source BoundingKit to compare to this object.
    Returns: | true if the objects are equivalent, 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.

  bool `operator!=`(BoundingKit const &in_kit) const

    Check if the source BoundingKit is not equivalent to this object.

    Parameters: | in_kit – The source BoundingKit to compare to this object.
    Returns: | true if the objects are not equivalent, false otherwise.

  BoundingKit &`operator=`(BoundingKit &&in_that)

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

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

  BoundingKit &`operator=`(BoundingKit const &in_kit)

    Copies the source BoundingKit into this object.

    Parameters: | in_kit – The source BoundingKit to copy.
    Returns: | A reference to this object.

  bool `operator==`(BoundingKit const &in_kit) const

    Check if the source BoundingKit is equivalent to this object.

    Parameters: | in_kit – The source BoundingKit to compare to this object.
    Returns: | true if the objects are equivalent, false otherwise.

  void `Set`(BoundingKit const &in_kit)

    Copies all settings from the source BoundingKit into this object.

    Parameters: | in_kit – The source BoundingKit to copy.

  BoundingKit &`SetExclusion`(bool in_exclude)

    Controls whether this segment should be excluded when computing bounding volumes.

    Parameters: | in_exclude – Whether to exclude this segment when computing bounding volumes.
    Returns: | A reference to this object.

  BoundingKit &`SetVolume`(SimpleCuboid const &in_cuboid)

    Explicitly sets the local bounding.

    Parameters: | in_cuboid – The SimpleCuboid to set the bounding volume to.
    Returns: | A reference to this object.

  BoundingKit &`SetVolume`(SimpleSphere const &in_sphere)

    Explicitly sets the local bounding.

    Parameters: | in_sphere – The SimpleSphere to set the bounding volume to.
    Returns: | A reference to this object.

  void `Show`(BoundingKit &out_kit) const

    Copies all settings from this BoundingKit into the given BoundingKit.

    Parameters: | out_kit – The BoundingKit to populate with the contents of this object.

  bool `ShowExclusion`(bool &out_exclusion) const

    Shows the bounding exclusion setting.

    Parameters: | out_exclusion – Whether to exclude this segment when computing bounding volumes.
    Returns: | true if the setting is valid, false otherwise.

  bool `ShowVolume`(SimpleSphere &out_sphere, SimpleCuboid &out_cuboid) const

    Shows the bounding volume.

    Parameters: | out_sphere – A sphere to show the volume into. If the bounding is not a sphere, this argument will be invalidated. out_cuboid – A cuboid to show the volume into. If the bounding is not a cuboid, this argument will be invalidated.
    Returns: | true if the setting is valid, false otherwise.

  BoundingKit &`UnsetEverything`()

    Removes all bounding settings from this object.

    Returns: | A reference to this object.

  BoundingKit &`UnsetExclusion`()

    Removes a bounding exclusion setting.

    Returns: | A reference to this object.

  BoundingKit &`UnsetVolume`()

    Removes an explicitly set bounding, reverting to the automatically generated one.

    Returns: | A reference to this object.

  virtual `~BoundingKit`()

    Destroy this kit.

  Public Static Functions

  static BoundingKit `GetDefault`()

    Creates a BoundingKit which contains the default settings. The returned object will not necessarily have values set for every option, but it will have settings for those options where it is reasonable to have a default.

    Returns: | A BoundingKit with the default settings.

  Public Static Attributes

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

Conversation saved
HOOPSY BETA

### Hello! I'm HOOPSY

Your multilingual generative AI assistant for documentation. Ask me anything about HOOPS Visualize Desktop in your own language, or choose a sample question below to start a conversation:

What is HOOPS Visualize Desktop?
What are the latest release notes for HOOPS Visualize Desktop?
How do I start evaluating HOOPS Visualize Desktop?
How do I write my first sample application?
How can I get assistance?

HOOPSY may store conversations according to OpenAI's policy. Responses may not always be accurate.

HOOPSY is thinking...