< Home

< Table of Contents

REFERENCE MANUAL

HPS.OffScreenWindowOptionsControl Class Reference

The OffScreenWindowOptionsControl class is a smart pointer that is tied to a database object. More...

Inheritance diagram for HPS.OffScreenWindowOptionsControl:
HPS.Control HPS.Object

Public Member Functions

override void Dispose ()
 
override HPS.Type ObjectType ()
 This function returns the type the object, as declared. More...
 
 OffScreenWindowOptionsControl (HPS.OffScreenWindowKey in_seg)
 This constructor creates a OffScreenWindowOptionsControl object which is tied to the specified offscreen window. More...
 
 OffScreenWindowOptionsControl (HPS.OffScreenWindowOptionsControl in_that)
 The copy constructor creates a OffScreenWindowOptionsControl object that shares the underlying smart-pointer of the source OffScreenWindowOptionsControl. More...
 
HPS.OffScreenWindowOptionsControl SetSize (uint in_width, uint in_height)
 Sets the width and height in pixels of the associated offscreen window. More...
 
bool ShowAntiAliasCapable (out bool out_state, out uint out_samples)
 Shows the whether this offscreen window is anti-alias capable, and if so, how many samples it uses for anti-aliasing. More...
 
bool ShowDriver (out HPS.Window.Driver out_driver)
 Shows the driver for the associated offscreen window. More...
 
bool ShowHardwareResident (out bool out_state)
 Shows the hardware resident option of the associated offscreen window. More...
 
bool ShowImage (HPS.Image.Format in_format, out HPS.ImageKit out_image)
 Shows the contents of this offscreen window into the provided ImageKit in the specified format. More...
 
bool ShowOpacity (out bool out_state, out float out_opacity)
 Shows the opacity of the associated offscreen window More...
 
bool ShowSize (out uint out_width, out uint out_height)
 Shows the width and height in pixels of the associated offscreen window. More...
 
- Public Member Functions inherited from HPS.Control
 Control (HPS.Control in_that)
 
- Public Member Functions inherited from HPS.Object
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. 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...
 

Protected Member Functions

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

Additional Inherited Members

- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 
- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 
HandleRef scptr
 

Detailed Description

The OffScreenWindowOptionsControl class is a smart pointer that is tied to a database object.

It is used to query offscreen-window-specific options on an OffScreenWindowKey. This control also gives you the ability to make a screenshot of the Visualize scene using ShowImage. This table lists default values for the various segment attributes accessible from OffScreenWindowOptionsControl.

Constructor & Destructor Documentation

HPS.OffScreenWindowOptionsControl.OffScreenWindowOptionsControl ( HPS.OffScreenWindowKey  in_seg)

This constructor creates a OffScreenWindowOptionsControl object which is tied to the specified offscreen window.

HPS.OffScreenWindowOptionsControl.OffScreenWindowOptionsControl ( HPS.OffScreenWindowOptionsControl  in_that)

The copy constructor creates a OffScreenWindowOptionsControl object that shares the underlying smart-pointer of the source OffScreenWindowOptionsControl.

Parameters
in_thatThe source <ref refid="class_h_p_s_1_1_off_screen_window_options_control" kindref="compound">OffScreenWindowOptionsControl</ref> to copy.

Member Function Documentation

override HPS.Type HPS.OffScreenWindowOptionsControl.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.

HPS.OffScreenWindowOptionsControl HPS.OffScreenWindowOptionsControl.SetSize ( uint  in_width,
uint  in_height 
)

Sets the width and height in pixels of the associated offscreen window.

Parameters
in_widthThe width in pixels of the associated offscreen window.
in_heightThe height in pixels of the associated offscreen window.
Returns
A reference to this OffScreenWindowOptionsControl.
bool HPS.OffScreenWindowOptionsControl.ShowAntiAliasCapable ( out bool  out_state,
out uint  out_samples 
)

Shows the whether this offscreen window is anti-alias capable, and if so, how many samples it uses for anti-aliasing.

Parameters
out_stateWhether this offscreen window is anti-alias capable.
out_samplesThe number of anti-alias samples supported by this offscreen window.
Returns
true if any anti-alias options were set, false otherwise.
bool HPS.OffScreenWindowOptionsControl.ShowDriver ( out HPS.Window.Driver  out_driver)

Shows the driver for the associated offscreen window.

Parameters
out_driverThe driver for the associated offscreen window.
Returns
true if a driver was set, false otherwise.
bool HPS.OffScreenWindowOptionsControl.ShowHardwareResident ( out bool  out_state)

Shows the hardware resident option of the associated offscreen window.

Parameters
out_stateWhether the image data for this offscreen window should be stored exclusively in video memory.
Returns
true if a hardware resident option was set, false otherwise.
bool HPS.OffScreenWindowOptionsControl.ShowImage ( HPS.Image.Format  in_format,
out HPS.ImageKit  out_image 
)

Shows the contents of this offscreen window into the provided ImageKit in the specified format.

Parameters
in_formatThe format of the image to generate.
out_imageThe contents of this offscreen window as an image in the specified format.
Returns
true if the shown image is valid, false otherwise.
bool HPS.OffScreenWindowOptionsControl.ShowOpacity ( out bool  out_state,
out float  out_opacity 
)

Shows the opacity of the associated offscreen window

Parameters
out_stateThe opacity value that will be applied when rendering the window background.
Returns
true if an opacity option was set, false otherwise.
bool HPS.OffScreenWindowOptionsControl.ShowSize ( out uint  out_width,
out uint  out_height 
)

Shows the width and height in pixels of the associated offscreen window.

Parameters
out_widthThe width in pixels of the associated offscreen window.
out_heightThe height in pixels of the associated offscreen window.
Returns
true if a height and width were set, false otherwise.

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