< Home

< Table of Contents

REFERENCE MANUAL

HPS.SubwindowKit Class Reference

The SubwindowKit class is a user space object, useful for carrying a group of attribute settings related to subwindows. More...

Inheritance diagram for HPS.SubwindowKit:
HPS.Object

Public Member Functions

override void Dispose ()
 
override bool Empty ()
 Indicates whether this object has any values set on it. More...
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.SubwindowKit in_kit)
 Check if the source SubwindowKit is equivalent to this object. More...
 
override int GetHashCode ()
 
override HPS.Type ObjectType ()
 This function returns the type the object, as declared. More...
 
void Set (HPS.SubwindowKit in_kit)
 Copies the source SubwindowKit into this object. More...
 
HPS.SubwindowKit SetBackground (HPS.Subwindow.Background in_bg_type, string in_definition_name)
 Controls the type of background to be used for subwindows originating from this segment. More...
 
HPS.SubwindowKit SetBackground (HPS.Subwindow.Background in_bg_type)
 Controls the type of background to be used for subwindows originating from this segment. More...
 
HPS.SubwindowKit SetBorder (HPS.Subwindow.Border in_border_type)
 Controls the type of border, if any, that should be drawn for subwindows originating from this segment. More...
 
HPS.SubwindowKit SetRenderingAlgorithm (HPS.Subwindow.RenderingAlgorithm in_hsra)
 Determines the algorithm used to remove objects (or parts of objects) that are hidden from view by other objects. More...
 
HPS.SubwindowKit SetSubwindow (HPS.Rectangle in_subwindow_position, HPS.Subwindow.Type in_subwindow_type)
 Defines a portion of the containing window to act as a subwindow. More...
 
HPS.SubwindowKit SetSubwindow (HPS.Rectangle in_subwindow_position)
 Defines a portion of the containing window to act as a subwindow. More...
 
void Show (out HPS.SubwindowKit out_kit)
 Copies this object into the given SubwindowKit. More...
 
bool ShowBackground (out HPS.Subwindow.Background out_bg_type, out string out_definition_name)
 Shows the window background setting More...
 
bool ShowBorder (out HPS.Subwindow.Border out_border_type)
 Shows the subwindow border setting More...
 
bool ShowRenderingAlgorithm (out HPS.Subwindow.RenderingAlgorithm out_hsra)
 Shows the rendering algorithm setting. More...
 
bool ShowSubwindow (out HPS.Rectangle out_subwindow_position, out HPS.Subwindow.Type out_subwindow_type)
 Shows the subwindow setting. More...
 
 SubwindowKit ()
 Initializes an empty kit. More...
 
 SubwindowKit (HPS.SubwindowKit in_kit)
 Copies the kit in_kit into this kit. More...
 
HPS.SubwindowKit UnsetBackground ()
 Removes a subwindow background setting. More...
 
HPS.SubwindowKit UnsetBorder ()
 Removes a subwindow border setting. More...
 
HPS.SubwindowKit UnsetEverything ()
 Removes all settings from this object. More...
 
HPS.SubwindowKit UnsetRenderingAlgorithm ()
 Removes a rendering algorithm setting. More...
 
HPS.SubwindowKit UnsetSubwindow ()
 Removes a subwindow setting. More...
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 Returns an identifier that can be used to identify which instance of a class an object is. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
 Object (HPS.Object in_that)
 The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More...
 
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. More...
 

Static Public Member Functions

static HPS.SubwindowKit GetDefault ()
 Creates a SubwindowKit which contains the default settings. More...
 
static bool operator!= (HPS.SubwindowKit a, HPS.SubwindowKit b)
 
static bool operator== (HPS.SubwindowKit a, HPS.SubwindowKit b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 
HandleRef scptr
 

Detailed Description

The SubwindowKit class is a user space object, useful for carrying a group of attribute settings related to subwindows.

Calling SubwindowKit::GetDefault() will return a kit with values found in this table.

Constructor & Destructor Documentation

HPS.SubwindowKit.SubwindowKit ( )

Initializes an empty kit.

HPS.SubwindowKit.SubwindowKit ( HPS.SubwindowKit  in_kit)

Copies the kit in_kit into this kit.

Member Function Documentation

override bool HPS.SubwindowKit.Empty ( )
virtual

Indicates whether this object has any values set on it.

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

Reimplemented from HPS.Object.

bool HPS.SubwindowKit.Equals ( HPS.SubwindowKit  in_kit)

Check if the source SubwindowKit is equivalent to this object.

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_subwindow_kit" kindref="compound">SubwindowKit</ref> to compare to this object.
Returns
true if the objects are equivalent, false otherwise.
static HPS.SubwindowKit HPS.SubwindowKit.GetDefault ( )
static

Creates a SubwindowKit 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 SubwindowKit with the default settings.
override HPS.Type HPS.SubwindowKit.ObjectType ( )
virtual

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.

void HPS.SubwindowKit.Set ( HPS.SubwindowKit  in_kit)

Copies the source SubwindowKit into this object.

Parameters
in_kitThe source object to copy.
HPS.SubwindowKit HPS.SubwindowKit.SetBackground ( HPS.Subwindow.Background  in_bg_type,
string  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 <ref refid="class_h_p_s_1_1_image" kindref="compound">Image</ref> or Cubemap.
Returns
A reference to this object.
HPS.SubwindowKit HPS.SubwindowKit.SetBackground ( HPS.Subwindow.Background  in_bg_type)

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.
Returns
A reference to this object.
HPS.SubwindowKit HPS.SubwindowKit.SetBorder ( HPS.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.
HPS.SubwindowKit HPS.SubwindowKit.SetRenderingAlgorithm ( HPS.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.
HPS.SubwindowKit HPS.SubwindowKit.SetSubwindow ( HPS.Rectangle  in_subwindow_position,
HPS.Subwindow.Type  in_subwindow_type 
)

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_subwindow_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 <ref refid="struct_h_p_s_1_1_rectangle" kindref="compound">Rectangle</ref>(0, 1, -1, 0) would occupy the lower right quarter of the containing window.
in_subwindow_typeThe type of subwindow to create.
Returns
A reference to this object.
HPS.SubwindowKit HPS.SubwindowKit.SetSubwindow ( HPS.Rectangle  in_subwindow_position)

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_subwindow_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 <ref refid="struct_h_p_s_1_1_rectangle" kindref="compound">Rectangle</ref>(0, 1, -1, 0) would occupy the lower right quarter of the containing window.
Returns
A reference to this object.
void HPS.SubwindowKit.Show ( out HPS.SubwindowKit  out_kit)

Copies this object into the given SubwindowKit.

Parameters
out_kitThe <ref refid="class_h_p_s_1_1_subwindow_kit" kindref="compound">SubwindowKit</ref> to populate with the contents of this object.
bool HPS.SubwindowKit.ShowBackground ( out HPS.Subwindow.Background  out_bg_type,
out string  out_definition_name 
)

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.
bool HPS.SubwindowKit.ShowBorder ( out HPS.Subwindow.Border  out_border_type)

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.
bool HPS.SubwindowKit.ShowRenderingAlgorithm ( out HPS.Subwindow.RenderingAlgorithm  out_hsra)

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.
bool HPS.SubwindowKit.ShowSubwindow ( out HPS.Rectangle  out_subwindow_position,
out HPS.Subwindow.Type  out_subwindow_type 
)

Shows the subwindow setting.

Parameters
out_subwindow_positionThe portion of the containing window that should be reserved for a subwindow.
out_subwindow_typeThe type of subwindow to create.
Returns
true if the setting is valid, false otherwise.
HPS.SubwindowKit HPS.SubwindowKit.UnsetBackground ( )

Removes a subwindow background setting.

Returns
A reference to this object.
HPS.SubwindowKit HPS.SubwindowKit.UnsetBorder ( )

Removes a subwindow border setting.

Returns
A reference to this object.
HPS.SubwindowKit HPS.SubwindowKit.UnsetEverything ( )

Removes all settings from this object.

Returns
A reference to this object.
HPS.SubwindowKit HPS.SubwindowKit.UnsetRenderingAlgorithm ( )

Removes a rendering algorithm setting.

Returns
A reference to this object.
HPS.SubwindowKit HPS.SubwindowKit.UnsetSubwindow ( )

Removes a subwindow setting.

Returns
A reference to this object.

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