HPS::SubwindowControl Class Reference

#include <hps.h>

Inheritance diagram for HPS::SubwindowControl:
HPS::Control HPS::Object

Public Member Functions

HPS::Type ObjectType () const
 
SubwindowControloperator= (SubwindowControl &&in_that)
 
SubwindowControloperator= (SubwindowControl const &in_that)
 
SubwindowControlSetBackground (Subwindow::Background in_bg_type, char const *in_definition_name="")
 
SubwindowControlSetBorder (Subwindow::Border in_border_type)
 
SubwindowControlSetModelCompareMode (bool in_state, SegmentKey const &in_source1=SegmentKey(), SegmentKey const &in_source2=SegmentKey())
 
SubwindowControlSetModelCompareMode (SegmentKey const &in_source1, SegmentKey const &in_source2)
 
SubwindowControlSetRenderingAlgorithm (Subwindow::RenderingAlgorithm in_hsra)
 
SubwindowControlSetSubwindow (Rectangle const &in_window_position, Subwindow::Type in_type=Subwindow::Type::Standard)
 
SubwindowControlSetSubwindow (Rectangle const &in_window_position, IntRectangle const &in_window_offsets, Subwindow::Type in_type=Subwindow::Type::Standard)
 
bool ShowBackground (Subwindow::Background &out_bg_type, UTF8 &out_definition_name) const
 
bool ShowBorder (Subwindow::Border &out_border_type) const
 
bool ShowModelCompareMode (bool &out_state, SegmentKey &out_source1, SegmentKey &out_source2) const
 
bool ShowRenderingAlgorithm (Subwindow::RenderingAlgorithm &out_hsra) const
 
bool ShowSubwindow (Rectangle &out_subwindow_position, IntRectangle &out_subwindow_offsets, Subwindow::Type &out_subwindow_type) const
 
 SubwindowControl (SegmentKey &in_seg)
 
 SubwindowControl (SubwindowControl const &in_that)
 
 SubwindowControl (SubwindowControl &&in_that)
 
virtual HPS::Type Type () const
 
SubwindowControlUnsetBackground ()
 
SubwindowControlUnsetBorder ()
 
SubwindowControlUnsetEverything ()
 
SubwindowControlUnsetModelCompareMode ()
 
SubwindowControlUnsetRenderingAlgorithm ()
 
SubwindowControlUnsetSubwindow ()
 
 ~SubwindowControl ()
 
- Public Member Functions inherited from HPS::Object
virtual bool Empty () const
 
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 
bool HasType (HPS::Type in_mask) const
 
 Object (Object const &that)
 
 Object (Object &&in_that)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 

Static Public Attributes

static const HPS::Type staticType = HPS::Type::SubwindowControl
 
- Static Public Attributes inherited from HPS::Control
static const HPS::Type staticType = HPS::Type::Control
 
- Static Public Attributes inherited from HPS::Object
static const HPS::Type staticType = HPS::Type::None
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t ClassID ()
 
- Protected Member Functions inherited from HPS::Control
 Control (Control &&in_that)
 
Controloperator= (Control &&in_that)
 

Detailed Description

The HPS::SubwindowControl class is a smart pointer that is tied to a database object. The HPS::SubwindowControl allows you to manipulate the various settings associated with subwindows, such as border, background, and priority. As the main Visualize window is also an implicit subwindow, this control also allows you to set the rendering algorithm. The rendering algorithm should only have a single setting for each window or subwindow. Setting disparate rendering algorithms in multiple places in your scene can lead to unexpected results.

Default values for the various fields of HPS::SubwindowControl can be found here.

Constructor & Destructor Documentation

◆ SubwindowControl() [1/3]

HPS::SubwindowControl::SubwindowControl ( SegmentKey in_seg)
explicit

Initializes a control tied to the segment in_seg.

◆ SubwindowControl() [2/3]

HPS::SubwindowControl::SubwindowControl ( SubwindowControl const &  in_that)

Initializes a control tied to the same object as in_that.

◆ SubwindowControl() [3/3]

HPS::SubwindowControl::SubwindowControl ( SubwindowControl &&  in_that)

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

Parameters
in_thatAn rvalue reference to a SubwindowControl to take the impl from.

◆ ~SubwindowControl()

HPS::SubwindowControl::~SubwindowControl ( )

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

Member Function Documentation

◆ ObjectType()

HPS::Type HPS::SubwindowControl::ObjectType ( ) const
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::Control.

◆ operator=() [1/2]

SubwindowControl& HPS::SubwindowControl::operator= ( SubwindowControl &&  in_that)

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

Parameters
in_thatAn rvalue reference to a SubwindowControl to take the impl from.
Returns
A reference to this SubwindowControl.

◆ operator=() [2/2]

SubwindowControl& HPS::SubwindowControl::operator= ( SubwindowControl const &  in_that)

Share the underlying smart-pointer of the SubwindowControl source.

Parameters
in_thatThe SubwindowControl source of the assignment.
Returns
A reference to this SubwindowControl.

◆ SetBackground()

SubwindowControl& HPS::SubwindowControl::SetBackground ( Subwindow::Background  in_bg_type,
char const *  in_definition_name = "" 
)

Controls the type of background to be used for subwindows originating from this segment. This has no effect when applied to segments without a subwindow present.

Parameters
in_bg_typeThe type of background to be used for subwindows originating from this segment.
in_definition_namethe name of a definition to be used in the background. Only relevant if in_bg_type is Image or Cubemap.
Returns
A reference to this object.

◆ SetBorder()

SubwindowControl& HPS::SubwindowControl::SetBorder ( Subwindow::Border  in_border_type)

Controls the type of border, if any, that should be drawn for subwindows originating from this segment. This has no effect when applied to segments without a subwindow present.

Parameters
in_border_typeThe type of border, if any, that should be drawn for subwindows originating from this segment.
Returns
A reference to this object.

◆ SetModelCompareMode() [1/2]

SubwindowControl& HPS::SubwindowControl::SetModelCompareMode ( bool  in_state,
SegmentKey const &  in_source1 = SegmentKey(),
SegmentKey const &  in_source2 = SegmentKey() 
)

Sets 'model compare' rendering mode which displays a visual diff between the two source segments in this subwindow.

Parameters
in_stateToggles compare mode on or off.
in_source1The first source model.
in_source2The second source model.
Returns
A reference to this object.

◆ SetModelCompareMode() [2/2]

SubwindowControl& HPS::SubwindowControl::SetModelCompareMode ( SegmentKey const &  in_source1,
SegmentKey const &  in_source2 
)

Sets 'model compare' rendering mode which displays a visual diff between the two source segments in this subwindow.

Parameters
in_source1The first source model.
in_source2The second source model.
Returns
A reference to this object.

◆ SetRenderingAlgorithm()

SubwindowControl& HPS::SubwindowControl::SetRenderingAlgorithm ( Subwindow::RenderingAlgorithm  in_hsra)

Determines the algorithm used to remove objects (or parts of objects) that are hidden from view by other objects. This has no effect when applied to segments without a subwindow present.

Parameters
in_hsraThe algorithm used to identify and remove hidden surfaces.
Returns
A reference to this object.
See also
Rendering algorithm default value

◆ SetSubwindow() [1/2]

SubwindowControl& HPS::SubwindowControl::SetSubwindow ( Rectangle const &  in_window_position,
Subwindow::Type  in_type = Subwindow::Type::Standard 
)

Defines a portion of the containing window to act as a subwindow. Window segments have an implicit subwindow of -1 to 1 in both x and y directions that cannot be changed. Other segments can be constrained to some portion of that space. Most other subwindow-related settings are only relevant if they are applied on a segment that also contains a subwindow.

Parameters
in_window_positionThe portion of the containing window that should be reserved for a subwindow. The subwindow is defined in the context of a rectangle extending out a single unit in each direction from the origin. For example, a subwindow rectangle defined as Rectangle(0, 1, -1, 0) would occupy the lower right quarter of the containing window.
in_typeThe type of subwindow to create.
Returns
A reference to this object.
See also
Subwindow default value

◆ SetSubwindow() [2/2]

SubwindowControl& HPS::SubwindowControl::SetSubwindow ( Rectangle const &  in_window_position,
IntRectangle const &  in_window_offsets,
Subwindow::Type  in_type = Subwindow::Type::Standard 
)

Defines a portion of the containing window to act as a subwindow. Window segments have an implicit subwindow of -1 to 1 in both x and y directions that cannot be changed. Other segments can be constrained to some portion of that space. Most other subwindow-related settings are only relevant if they are applied on a segment that also contains a subwindow.

Parameters
in_window_positionThe portion of the containing window that should be reserved for a subwindow. The subwindow is defined in the context of a rectangle extending out a single unit in each direction from the origin. For example, a subwindow rectangle defined as Rectangle(0, 1, -1, 0) would occupy the lower right quarter of the containing window.
in_window_offsetsThe pixel-space offsets to apply to each side of the given window position.
in_typeThe type of subwindow to create.
Returns
A reference to this object.
See also
Subwindow default value

◆ ShowBackground()

bool HPS::SubwindowControl::ShowBackground ( Subwindow::Background out_bg_type,
UTF8 out_definition_name 
) const

Shows the window background setting

Parameters
out_bg_typeThe type of background to be used for subwindows originating from this segment.
out_definition_namethe name of a definition to be used in the background.
Returns
true if the setting is valid, false otherwise.

◆ ShowBorder()

bool HPS::SubwindowControl::ShowBorder ( Subwindow::Border out_border_type) const

Shows the subwindow border setting

Parameters
out_border_typeThe type of border, if any, that should be drawn for subwindows originating from this segment.
Returns
true if the setting is valid, false otherwise.

◆ ShowModelCompareMode()

bool HPS::SubwindowControl::ShowModelCompareMode ( bool &  out_state,
SegmentKey out_source1,
SegmentKey out_source2 
) const

Shows the model compare setting.

Parameters
out_stateThe model compare enabled state.
out_source1The first source model.
out_source2The second source model.
Returns
true if the setting is valid, false otherwise.

◆ ShowRenderingAlgorithm()

bool HPS::SubwindowControl::ShowRenderingAlgorithm ( Subwindow::RenderingAlgorithm out_hsra) const

Shows the rendering algorithm setting.

Parameters
out_hsraThe algorithm used to identify and remove hidden surfaces.
Returns
true if the setting is valid, false otherwise.

◆ ShowSubwindow()

bool HPS::SubwindowControl::ShowSubwindow ( Rectangle out_subwindow_position,
IntRectangle out_subwindow_offsets,
Subwindow::Type out_subwindow_type 
) const

Shows the subwindow setting.

Parameters
out_subwindow_positionThe portion of the containing window that should be reserved for a subwindow.
out_subwindow_offsetsThe pixel-space offsets being applied to the subwindow position.
out_subwindow_typeThe type of subwindow to create.
Returns
true if the setting is valid, false otherwise.

◆ Type()

virtual HPS::Type HPS::SubwindowControl::Type ( ) const
inlinevirtual

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.

Warning
This function must synchronize the database (by waiting for all pending database operations to complete) in order to know the type status of this object with certainty. Therefore this function can negatively impact performance. You should vigorously avoid using this function in high-traffic or peformance-critical areas of your code.
Returns
The true type of the object in question.

Reimplemented from HPS::Control.

◆ UnsetBackground()

SubwindowControl& HPS::SubwindowControl::UnsetBackground ( )

Removes a subwindow background setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by SubwindowKit::GetDefault().

Returns
A reference to this object.

◆ UnsetBorder()

SubwindowControl& HPS::SubwindowControl::UnsetBorder ( )

Removes a subwindow border setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by SubwindowKit::GetDefault().

Returns
A reference to this object.

◆ UnsetEverything()

SubwindowControl& HPS::SubwindowControl::UnsetEverything ( )

Removes all settings from this object. If the control is attached to a WindowKey this function restores the default settings of this control as specified by SubwindowKit::GetDefault().

Returns
A reference to this object.

◆ UnsetModelCompareMode()

SubwindowControl& HPS::SubwindowControl::UnsetModelCompareMode ( )

Removes model compare setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by SubwindowKit::GetDefault().

Returns
A reference to this object.

◆ UnsetRenderingAlgorithm()

SubwindowControl& HPS::SubwindowControl::UnsetRenderingAlgorithm ( )

Removes a rendering algorithm setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by SubwindowKit::GetDefault().

Returns
A reference to this object.

◆ UnsetSubwindow()

SubwindowControl& HPS::SubwindowControl::UnsetSubwindow ( )

Removes a subwindow setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by SubwindowKit::GetDefault().

Returns
A reference to this object.

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