HPS::StandAloneWindowOptionsControl Class Reference

#include <hps.h>

Inheritance diagram for HPS::StandAloneWindowOptionsControl:

Collaboration diagram for HPS::StandAloneWindowOptionsControl:

Public Member Functions
	StandAloneWindowOptionsControl (StandAloneWindowKey &in_seg)
	This constructor creates a StandAloneWindowOptionsControl object which is tied to the specified offscreen window. More...
	StandAloneWindowOptionsControl (StandAloneWindowOptionsControl const &in_that)
	The copy constructor creates a StandAloneWindowOptionsControl object that shares the underlying smart-pointer of the source StandAloneWindowOptionsControl. More...
	StandAloneWindowOptionsControl (StandAloneWindowOptionsControl &&in_that)
	The move constructor creates a StandAloneWindowOptionsControl by transferring the underlying impl of the rvalue reference to this StandAloneWindowOptionsControl thereby avoiding a copy and allocation. More...
StandAloneWindowOptionsControl &	operator= (StandAloneWindowOptionsControl &&in_that)
	The move assignment operator transfers the underlying impl of the rvalue reference to this StandAloneWindowOptionsControl thereby avoiding a copy. More...
	~StandAloneWindowOptionsControl ()
	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
StandAloneWindowOptionsControl &	operator= (StandAloneWindowOptionsControl const &in_that)
	Share the underlying smart-pointer of the StandAloneWindowOptionsControl source. More...
StandAloneWindowOptionsControl &	SetSubscreen (Rectangle const &in_subscreen)
	Sets the subscreen to render into for this stand-alone window. More...
StandAloneWindowOptionsControl &	SetMobility (Window::Mobility in_mobility)
	Sets the mobility for this stand-alone window. More...
StandAloneWindowOptionsControl &	SetFullScreen (bool in_state)
	Sets whether this stand-alone window should fill the screen. More...
StandAloneWindowOptionsControl &	SetFallbackFonts (UTF8Array const &in_fonts)
	Supplies an array of fonts to be used as fallbacks for when a character can not be found in the active font. More...
StandAloneWindowOptionsControl &	UnsetFallbackFonts ()
	Unsets any fonts currently used as fallback fonts. More...
size_t	ShowFallbackFonts (UTF8Array &out_fonts) const
	Returns an array of fonts set to be used as fallbacks for when a character can not be found in the active font. More...
bool	ShowDriver (Window::Driver &out_driver) const
	Shows the driver for this stand-alone window. More...
StandAloneWindowOptionsControl &	SetAntiAliasCapable (bool in_state, unsigned int in_samples=4)
	Sets the anti-alias options for this StandAloneWindowOptionsControl. More...
bool	ShowAntiAliasCapable (bool &out_state, unsigned int &out_samples) const
	Shows the whether this stand-alone window is anti-alias capable, and if so, how many samples it uses for anti-aliasing. More...
bool	ShowTitle (UTF8 &out_window_name) const
	Shows the title for this stand-alone window. More...
bool	ShowSubscreen (Rectangle &out_subscreen) const
	Shows the subscreen for this stand-alone window. More...
bool	ShowMobility (Window::Mobility &out_mobility) const
	Shows the mobility for this stand-alone window. More...
bool	ShowFullScreen (bool &out_state) const
	Shows whether this stand-alone window should fill the screen. More...
bool	ShowWindowHandle (WindowHandle &out_window_handle) const
	Shows the window handle for the associated standalone 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::StandAloneWindowOptionsControl

Private Member Functions
	StandAloneWindowOptionsControl ()
	Private default constructor to prevent instantiation without an offscreen window. More...

Detailed Description

The HPS::StandAloneWindowOptionsControl class is a smart pointer that is tied to a database object. It is used to set and query stand-alone-window-specific options on a HPS::StandAloneWindowKey.

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

Constructor & Destructor Documentation

StandAloneWindowOptionsControl() [1/4]

HPS::StandAloneWindowOptionsControl::StandAloneWindowOptionsControl ( StandAloneWindowKey &  in_seg )

explicit

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

Parameters

in_window

The application window which this StandAloneWindowOptionsControl should operate on.

StandAloneWindowOptionsControl() [2/4]

HPS::StandAloneWindowOptionsControl::StandAloneWindowOptionsControl

(

StandAloneWindowOptionsControl const &

in_that

)

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

Parameters

in_that

The source StandAloneWindowOptionsControl to copy.

StandAloneWindowOptionsControl() [3/4]

HPS::StandAloneWindowOptionsControl::StandAloneWindowOptionsControl

(

StandAloneWindowOptionsControl &&

in_that

)

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

Parameters

in_that

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

~StandAloneWindowOptionsControl()

HPS::StandAloneWindowOptionsControl::~StandAloneWindowOptionsControl

(

)

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

StandAloneWindowOptionsControl() [4/4]

HPS::StandAloneWindowOptionsControl::StandAloneWindowOptionsControl ( )

private

Private default constructor to prevent instantiation without an offscreen 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::StandAloneWindowOptionsControl::ObjectType ( ) const

inlinevirtual

Reimplemented from HPS::Control.

operator=() [1/2]

StandAloneWindowOptionsControl& HPS::StandAloneWindowOptionsControl::operator=

(

StandAloneWindowOptionsControl &&

in_that

)

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

Parameters

in_that

An rvalue reference to an StandAloneWindowOptionsControl to take the impl from.

Returns

A reference to this StandAloneWindowOptionsControl.

operator=() [2/2]

StandAloneWindowOptionsControl& HPS::StandAloneWindowOptionsControl::operator=

(

StandAloneWindowOptionsControl const &

in_that

)

Share the underlying smart-pointer of the StandAloneWindowOptionsControl source.

Parameters

in_that

The StandAloneWindowOptionsControl source of the assignment.

Returns

A reference to this StandAloneWindowOptionsControl.

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.

SetAntiAliasCapable()

StandAloneWindowOptionsControl& HPS::StandAloneWindowOptionsControl::SetAntiAliasCapable	(	bool	in_state,
		unsigned int	in_samples = 4
	)

Sets the anti-alias options for this StandAloneWindowOptionsControl.

Parameters

in_state	Whether the associated stand-alone window should be anti-alias capable.
in_samples	The number of anti-alias samples to use for the associated stand-alone window. Defaults to 4.

Returns

A reference to this StandAloneWindowOptionsControl.

SetFallbackFonts()

StandAloneWindowOptionsControl& HPS::StandAloneWindowOptionsControl::SetFallbackFonts

(

UTF8Array const &

in_fonts

)

Supplies an array of fonts to be used as fallbacks for when a character can not be found in the active font.

Parameters

in_fonts

An array of UTF8 encoded strings that correspond to the fallback fonts being used.

SetFullScreen()

StandAloneWindowOptionsControl& HPS::StandAloneWindowOptionsControl::SetFullScreen

(

bool

in_state

)

Sets whether this stand-alone window should fill the screen.

Parameters

in_state

Whether this stand-alone window should fill the screen.

Returns

A reference to this StandAloneWindowOptionsControl.

SetMobility()

StandAloneWindowOptionsControl& HPS::StandAloneWindowOptionsControl::SetMobility

(

Window::Mobility

in_mobility

)

Sets the mobility for this stand-alone window.

Mobility refers to the resizing and positioning behaviors of a window.

Parameters

in_mobility

The mobility for this stand-alone window.

Returns

A reference to this StandAloneWindowOptionsControl.

SetSubscreen()

StandAloneWindowOptionsControl& HPS::StandAloneWindowOptionsControl::SetSubscreen

(

Rectangle const &

in_subscreen

)

Sets the subscreen to render into for this stand-alone window.

Parameters

in_subscreen

The subscreen to render into for this stand-alone window. The units of the Rectangle are in window space, so -1.0f corresponds to the left (or bottom) of the window and 1.0f corresponds to the right (or top) of the window.

Returns

A reference to this StandAloneWindowOptionsControl.

ShowAntiAliasCapable()

bool HPS::StandAloneWindowOptionsControl::ShowAntiAliasCapable	(	bool &	out_state,
		unsigned int &	out_samples
	)		const

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

Parameters

out_state	Whether this stand-alone window is anti-alias capable.
out_samples	The number of anti-alias samples supported by this stand-alone window.

Returns

true if any anti-alias options were set, false otherwise.

ShowDriver()

bool HPS::StandAloneWindowOptionsControl::ShowDriver

(

Window::Driver &

out_driver

)

const

Shows the driver for this stand-alone window.

Parameters

out_driver

The driver for this stand-alone window.

Returns

true if a driver was set, false otherwise.

ShowFallbackFonts()

size_t HPS::StandAloneWindowOptionsControl::ShowFallbackFonts

(

UTF8Array &

out_fonts

)

const

Returns an array of fonts set to be used as fallbacks for when a character can not be found in the active font.

Parameters

out_fonts

An array of UTF8 encoded strings that correspond to the fallback fonts being used.

ShowFullScreen()

bool HPS::StandAloneWindowOptionsControl::ShowFullScreen

(

bool &

out_state

)

const

Shows whether this stand-alone window should fill the screen.

Parameters

out_state

Whether this stand-alone window should fill the screen.

Returns

true if a full screen flag was set, false otherwise.

ShowMobility()

bool HPS::StandAloneWindowOptionsControl::ShowMobility

(

Window::Mobility &

out_mobility

)

const

Shows the mobility for this stand-alone window.

Parameters

out_mobility

The mobility for this stand-alone window.

Returns

true if a mobility was set, false otherwise.

ShowSubscreen()

bool HPS::StandAloneWindowOptionsControl::ShowSubscreen

(

Rectangle &

out_subscreen

)

const

Shows the subscreen for this stand-alone window.

Parameters

out_subscreen

The subscreen for this stand-alone window.

Returns

true if a subscreen was set, false otherwise.

ShowTitle()

bool HPS::StandAloneWindowOptionsControl::ShowTitle

(

UTF8 &

out_window_name

)

const

Shows the title for this stand-alone window.

Parameters

out_window_name

UTF8-encoded title for this stand-alone window.

Returns

true if a title was set, false otherwise.

ShowWindowHandle()

bool HPS::StandAloneWindowOptionsControl::ShowWindowHandle

(

WindowHandle &

out_window_handle

)

const

Shows the window handle for the associated standalone window.

Parameters

out_window_handle

The window handle for the associated standalone window.

Returns

true if a window handle is available, false otherwise.

Type()

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

UnsetFallbackFonts()

StandAloneWindowOptionsControl& HPS::StandAloneWindowOptionsControl::UnsetFallbackFonts

(

)

Unsets any fonts currently used as fallback fonts.

Member Data Documentation

staticType

const HPS::Type HPS::StandAloneWindowOptionsControl::staticType = HPS::Type::StandAloneWindowOptionsControl

static

---

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

• hps.h