HPS::WindowInfoControl Class Reference

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

#include <hps.h>

Inheritance diagram for HPS::WindowInfoControl:

Collaboration diagram for HPS::WindowInfoControl:

Public Member Functions
	WindowInfoControl (WindowKey &in_window)
	Initializes a control tied to the window segment in_window. More...
	WindowInfoControl (WindowInfoControl const &in_that)
	Initializes a control tied to the same object as in_that. More...
	WindowInfoControl (WindowInfoControl &&in_that)
	The move constructor creates a WindowInfoControl by transferring the underlying impl of the rvalue reference to this WindowInfoControl thereby avoiding a copy and allocation. More...
WindowInfoControl &	operator= (WindowInfoControl &&in_that)
	The move assignment operator transfers the underlying impl of the rvalue reference to this WindowInfoControl thereby avoiding a copy. More...
	~WindowInfoControl ()
	Releases a reference to the database object this control is tied to. More...
virtual HPS::Type	Type () const
	This function returns the true type of the underlying object. More...
HPS::Type	ObjectType () const
WindowInfoControl &	operator= (WindowInfoControl const &in_that)
	Share the underlying smart-pointer of the WindowInfoControl source. More...
bool	ShowPhysicalPixels (unsigned int &out_width, unsigned int &out_height) const
	Shows the number of pixels in the physical display (monitor, off-screen renderer, printer, etc.). More...
bool	ShowPhysicalSize (float &out_width, float &out_height) const
	Shows the size, in centimeters, of the physical display (monitor, off-screen renderer, printer, etc.). More...
bool	ShowWindowPixels (unsigned int &out_width, unsigned int &out_height) const
	Shows the number of pixels in the window. More...
bool	ShowWindowSize (float &out_width, float &out_height) const
	Shows the size, in centimeters, of the window. More...
bool	ShowResolution (float &out_horizontal, float &out_vertical) const
	Shows both the horizontal and vertical resolution of the window. More...
bool	ShowWindowAspectRatio (float &out_window_aspect) const
	Shows the aspect ratio of the window. More...
bool	ShowPixelAspectRatio (float &out_pixel_aspect) const
	Shows the aspect ratio of the window's pixels. More...
bool	ShowMaxTextureSize (unsigned int &out_width, unsigned int &out_height) const
	Shows the maximum texture size that can be used. More...
bool	ShowLastUpdateTime (Time &out_time) const
	Shows the time taken (in milliseconds) to complete the last update. More...
bool	ShowDepthPeelingLayers (size_t &out_layers) const
	Shows the number of depth peeling layers that are supported for this window associated with this control. More...
bool	ShowVideoMemory (size_t &out_video_memory) const
	Shows the number (in MB) of video memory available on the system. More...
bool	ShowDepthBufferSize (size_t &out_bits) const
	Shows the number of bits used in this window's depth buffer. More...
bool	ShowMaxLights (size_t &out_lights) const
	Shows the maximum number of lights that can be used within the window associated with this control. More...
bool	ShowColorBitPlanes (size_t &out_planes) const
	Shows the number of color bit planes present for each pixel in the frame buffer. More...
bool	ShowLastUpdateInfo (UpdateInfo &out_info) const
	Shows information pertaining to the last performed update. More...
bool	ShowGPUName (UTF8 &out_name) const
	Shows the name of the GPU that is being used to render to this window. More...
virtual bool	Empty () const
	Indicates whether this object has any values set on it. More...
virtual void	Reset ()
	Resets this object to its initial, uninitialized state. More...
bool	HasType (HPS::Type in_mask) const
	This function indicates whether this Object has the given Type mask. More...
intptr_t	GetClassID () const
	Returns a unique identifier that is shared by all objects of the same class. More...
intptr_t	GetInstanceID () const
	Returns an identifier that can be used to identify which instance of a class an object is. More...

Static Public Member Functions
template<typename T >
static intptr_t	ClassID ()
	Unique identifier for this class. More...

Static Public Attributes
static const HPS::Type	staticType = HPS::Type::WindowInfoControl

Private Member Functions
	WindowInfoControl ()
	Private default constructor to prevent instantiation without a window. More...

Detailed Description

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

This object allows you to query various attributes about a window, such as its size and aspect ratio.

Constructor & Destructor Documentation

WindowInfoControl() [1/4]

HPS::WindowInfoControl::WindowInfoControl ( WindowKey &  in_window )

explicit

Initializes a control tied to the window segment in_window.

WindowInfoControl() [2/4]

HPS::WindowInfoControl::WindowInfoControl

(

WindowInfoControl const &

in_that

)

Initializes a control tied to the same object as in_that.

WindowInfoControl() [3/4]

HPS::WindowInfoControl::WindowInfoControl

(

WindowInfoControl &&

in_that

)

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

Parameters

in_that

An rvalue reference to a WindowInfoControl to take the impl from.

~WindowInfoControl()

HPS::WindowInfoControl::~WindowInfoControl

(

)

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

WindowInfoControl() [4/4]

HPS::WindowInfoControl::WindowInfoControl ( )

private

Private default constructor to prevent instantiation without a window.

Member Function Documentation

ClassID()

template<typename T >

static intptr_t HPS::Object::ClassID ( )

inlinestaticinherited

Unique identifier for this class.

Note: this method uses construction of static objects. If used in a constructor, it should be used in the body not the initializer list.

Empty()

virtual bool HPS::Object::Empty ( ) const

inlinevirtualinherited

Indicates whether this object has any values set on it.

Returns

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

Reimplemented in HPS::STL::ImportResultsKit, HPS::STL::ImportOptionsKit, HPS::OBJ::ImportResultsKit, HPS::OBJ::ImportOptionsKit, HPS::Hardcopy::File::ExportOptionsKit, HPS::Stream::ExportOptionsKit, HPS::Stream::ImportResultsKit, HPS::Stream::ImportOptionsKit, HPS::PointCloud::ImportOptionsKit, HPS::PointCloud::ImportResultsKit, HPS::UpdateOptionsKit, HPS::HighlightSearchOptionsKit, HPS::HighlightOptionsKit, HPS::SelectionOptionsKit, HPS::SearchOptionsKit, HPS::CutGeometryGatheringOptionsKit, HPS::ShapeKit, HPS::ShaderKit, HPS::Shader::ImportOptionsKit, HPS::ImageKit, HPS::Image::ImportOptionsKit, HPS::Image::ExportOptionsKit, HPS::TextureOptionsKit, HPS::LinePatternKit, HPS::LinePatternParallelKit, HPS::LinePatternOptionsKit, HPS::GlyphKit, HPS::ApplicationWindowOptionsKit, HPS::OffScreenWindowOptionsKit, HPS::StandAloneWindowOptionsKit, HPS::GridKit, HPS::PolygonKit, HPS::MeshKit, HPS::ShellKit, HPS::ShellRelationResultsKit, HPS::ShellRelationOptionsKit, HPS::ShellOptimizationOptionsKit, HPS::TextKit, HPS::EllipticalArcKit, HPS::EllipseKit, HPS::TrimKit, HPS::NURBSSurfaceKit, HPS::NURBSCurveKit, HPS::SpotlightKit, HPS::InfiniteLineKit, HPS::CuttingSectionKit, HPS::CircularWedgeKit, HPS::CircularArcKit, HPS::CircleKit, HPS::SphereKit, HPS::CylinderKit, HPS::DistantLightKit, HPS::MarkerKit, HPS::LineKit, HPS::AttributeLockKit, HPS::FontInfoState, HPS::WindowInfoKit, HPS::DebuggingKit, HPS::SubwindowKit, HPS::ContourLineKit, HPS::VisualEffectsKit, HPS::TransformMaskKit, HPS::PostProcessEffectsKit, HPS::DrawingAttributeKit, HPS::HiddenLineAttributeKit, HPS::PerformanceKit, HPS::NURBSSurfaceAttributeKit, HPS::MaterialKit, HPS::MaterialMappingKit, HPS::MatrixKit, HPS::CurveAttributeKit, HPS::EdgeAttributeKit, HPS::LineAttributeKit, HPS::TextAttributeKit, HPS::CuttingSectionAttributeKit, HPS::CylinderAttributeKit, HPS::LightingAttributeKit, HPS::SphereAttributeKit, HPS::MarkerAttributeKit, HPS::CullingKit, HPS::ColorInterpolationKit, HPS::TransparencyKit, HPS::SelectabilityKit, HPS::CameraKit, HPS::VisibilityKit, HPS::BoundingKit, HPS::SegmentOptimizationOptionsKit, HPS::Publish::ExportOptionsKit, HPS::Publish::TextFieldKit, HPS::Publish::SignatureFieldKit, HPS::Publish::DropDownListKit, HPS::Exchange::TessellationOptionsKit, HPS::Publish::ListBoxKit, HPS::Exchange::ExportSTEPOptionsKit, HPS::Exchange::ExportParasolidOptionsKit, HPS::Publish::RadioButtonKit, HPS::Exchange::ExportIGESOptionsKit, HPS::Exchange::ExportXMLOptionsKit, HPS::Publish::CheckBoxKit, HPS::Exchange::ExportU3DOptionsKit, HPS::Exchange::ExportSTLOptionsKit, HPS::Publish::ButtonKit, HPS::Exchange::ExportPRCOptionsKit, HPS::Publish::LinkKit, HPS::Exchange::ExportJTOptionsKit, HPS::Publish::SlideTableKit, HPS::Exchange::ExportACISOptionsKit, HPS::Publish::TableKit, HPS::Exchange::Export3MFOptionsKit, HPS::Publish::ImageKit, HPS::Publish::TextKit, HPS::Exchange::ModelFileImportOptionsKit, HPS::Publish::ViewKit, HPS::Exchange::TranslationOptionsKit, HPS::Publish::ArtworkKit, HPS::Publish::AnnotationKit, HPS::ComponentPath, HPS::Exchange::ImportOptionsKit, HPS::Parasolid::ExportOptionsKit, HPS::Exchange::NURBSConversionOptionsKit, HPS::Parasolid::LineTessellationKit, HPS::Exchange::Configuration, HPS::Publish::PageKit, HPS::Parasolid::FacetTessellationKit, HPS::Publish::DocumentKit, HPS::Parasolid::ImportOptionsKit, HPS::DWG::ImportOptionsKit, HPS::OOC::ImportOptionsKit, HPS::Sketchup::ImportOptionsKit, and HPS::Sketchup::ImportResultsKit.

GetClassID()

intptr_t HPS::Object::GetClassID ( ) const

inherited

Returns a unique identifier that is shared by all objects of the same class.

Returns

A unique value shared by all objects of the same class.

GetInstanceID()

intptr_t HPS::Object::GetInstanceID ( ) const

inherited

Returns an identifier that can be used to identify which instance of a class an object is.

Different keys and controls will return the same value if they are backed by the same database resource.

Returns

A value unique to an instance of an object and all objects that are backed by the same database resource.

HasType()

bool HPS::Object::HasType ( HPS::Type  in_mask ) const

inherited

This function indicates whether this Object has the given Type mask.

Parameters

in_mask

The Type mask to check against this Object.

Returns

true if this Object has the given Type mask, false otherwise.

ObjectType()

HPS::Type HPS::WindowInfoControl::ObjectType ( ) const

inlinevirtual

Reimplemented from HPS::Control.

operator=() [1/2]

WindowInfoControl& HPS::WindowInfoControl::operator=

(

WindowInfoControl &&

in_that

)

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

Parameters

in_that

An rvalue reference to a WindowInfoControl to take the impl from.

Returns

A reference to this WindowInfoControl.

operator=() [2/2]

WindowInfoControl& HPS::WindowInfoControl::operator=

(

WindowInfoControl const &

in_that

)

Share the underlying smart-pointer of the WindowInfoControl source.

Parameters

in_that

The WindowInfoControl source of the assignment.

Returns

A reference to this WindowInfoControl.

Reset()

virtual void HPS::Object::Reset ( )

virtualinherited

Resets this object to its initial, uninitialized state.

Reimplemented in HPS::EventHandler, HPS::EventDispatcher, HPS::World, HPS::HighlightSearchResults, HPS::HighlightSearchResultsIterator, HPS::SelectionResults, HPS::SelectionResultsIterator, HPS::FontSearchResults, HPS::FontSearchResultsIterator, HPS::SearchResults, and HPS::SearchResultsIterator.

ShowColorBitPlanes()

bool HPS::WindowInfoControl::ShowColorBitPlanes

(

size_t &

out_planes

)

const

Shows the number of color bit planes present for each pixel in the frame buffer.

Parameters

out_planes

The number of color bit planes present for each pixel in the frame buffer.

Returns

true if the color bit plane count can be queried from the hardware, false otherwise.

ShowDepthBufferSize()

bool HPS::WindowInfoControl::ShowDepthBufferSize

(

size_t &

out_bits

)

const

Shows the number of bits used in this window's depth buffer.

Parameters

out_bits

The number of bits used in this window's depth buffer.

Returns

true if depth buffer size can be queried from the hardware, false otherwise.

ShowDepthPeelingLayers()

bool HPS::WindowInfoControl::ShowDepthPeelingLayers

(

size_t &

out_layers

)

const

Shows the number of depth peeling layers that are supported for this window associated with this control.

Parameters

out_layers

The number of depth peeling layers that are supported for this window associated with this control.

Returns

true if depth peeling layers can be queried from the hardware, false otherwise.

ShowGPUName()

bool HPS::WindowInfoControl::ShowGPUName

(

UTF8 &

out_name

)

const

Shows the name of the GPU that is being used to render to this window.

Parameters

out_name

The name of the GPU.

Returns

true if the name can be queried from the hardware, false otherwise.

ShowLastUpdateInfo()

bool HPS::WindowInfoControl::ShowLastUpdateInfo

(

UpdateInfo &

out_info

)

const

Shows information pertaining to the last performed update.

Parameters

out_info

The information pertaining to the last performed update.

Returns

false if called before the initial update, true otherwise.

ShowLastUpdateTime()

bool HPS::WindowInfoControl::ShowLastUpdateTime

(

Time &

out_time

)

const

Shows the time taken (in milliseconds) to complete the last update.

This function is limited to the resolution of the system timer. In practice, that means that frame rates above 20 per second cannot be accurately measured in this manner.

Parameters

out_time

The time taken (in milliseconds) to complete the last update.

Returns

false if called before the initial update, true otherwise.

ShowMaxLights()

bool HPS::WindowInfoControl::ShowMaxLights

(

size_t &

out_lights

)

const

Shows the maximum number of lights that can be used within the window associated with this control.

Parameters

out_lights

The maximum number of lights that can be used within the window associated with this control.

Returns

true if the maximum light count can be queried from the hardware, false otherwise.

ShowMaxTextureSize()

bool HPS::WindowInfoControl::ShowMaxTextureSize	(	unsigned int &	out_width,
		unsigned int &	out_height
	)		const

Shows the maximum texture size that can be used.

Parameters

out_width	The maximum texture width that can be used.
out_height	The maximum texture height that can be used.

Returns

true if the maximum texture size can be queried from the hardware, false otherwise.

ShowPhysicalPixels()

bool HPS::WindowInfoControl::ShowPhysicalPixels	(	unsigned int &	out_width,
		unsigned int &	out_height
	)		const

Shows the number of pixels in the physical display (monitor, off-screen renderer, printer, etc.).

Parameters

out_width	The width of the physical display in pixels.
out_height	The height of the physical display in pixels.

Returns

true if the setting is valid, false otherwise.

ShowPhysicalSize()

bool HPS::WindowInfoControl::ShowPhysicalSize	(	float &	out_width,
		float &	out_height
	)		const

Shows the size, in centimeters, of the physical display (monitor, off-screen renderer, printer, etc.).

Parameters

out_width	The width of the physical display in centimeters.
out_height	The height of the physical display in centimeters.

Returns

true if the setting is valid, false otherwise.

ShowPixelAspectRatio()

bool HPS::WindowInfoControl::ShowPixelAspectRatio

(

float &

out_pixel_aspect

)

const

Shows the aspect ratio of the window's pixels.

This is computed as the horizontal resolution divided by the vertical resolution.

Parameters

out_pixel_aspect

The aspect ratio of the window defined as width / height in pixels.

Returns

true if the setting is valid, false otherwise.

ShowResolution()

bool HPS::WindowInfoControl::ShowResolution	(	float &	out_horizontal,
		float &	out_vertical
	)		const

Shows both the horizontal and vertical resolution of the window.

Resolution is computed as pixels per centimeter. If the size or the pixels are not set, this function will return false.

Parameters

out_horizontal	The horizontal resolution of the window.
out_vertical	The vertical resolution of the window.

Returns

true if the setting is valid, false otherwise.

ShowVideoMemory()

bool HPS::WindowInfoControl::ShowVideoMemory

(

size_t &

out_video_memory

)

const

Shows the number (in MB) of video memory available on the system.

Parameters

out_video_memory

The number (in MB) of video memory available on the system.

Returns

true if video memory can be queried from the hardware, false otherwise.

ShowWindowAspectRatio()

bool HPS::WindowInfoControl::ShowWindowAspectRatio

(

float &

out_window_aspect

)

const

Shows the aspect ratio of the window.

Aspect ratio is computed as width / height in centimeters.

Parameters

out_window_aspect

The aspect ratio of the window defined as width / height in centimeters.

Returns

true if the setting is valid, false otherwise.

ShowWindowPixels()

bool HPS::WindowInfoControl::ShowWindowPixels	(	unsigned int &	out_width,
		unsigned int &	out_height
	)		const

Shows the number of pixels in the window.

Parameters

out_width	The width of the window in pixels.
out_height	The height of the window in pixels.

Returns

true if the setting is valid, false otherwise.

ShowWindowSize()

bool HPS::WindowInfoControl::ShowWindowSize	(	float &	out_width,
		float &	out_height
	)		const

Shows the size, in centimeters, of the window.

Parameters

out_width	The width of the window in centimeters.
out_height	The height of the window in centimeters.

Returns

true if the setting is valid, false otherwise.

Type()

virtual HPS::Type HPS::WindowInfoControl::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.

Returns

The true type of the object in question.

Reimplemented from HPS::Control.

Member Data Documentation

staticType

const HPS::Type HPS::WindowInfoControl::staticType = HPS::Type::WindowInfoControl

static

---

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

• hps.h