HPS::ApplicationWindowOptionsControl Class Reference

The HPS::ApplicationWindowOptionsControl class is a smart pointer that is tied to a database object. More...

#include <hps.h>

Inheritance diagram for HPS::ApplicationWindowOptionsControl:

Collaboration diagram for HPS::ApplicationWindowOptionsControl:

Public Member Functions
	ApplicationWindowOptionsControl (ApplicationWindowKey &in_seg)
	This constructor creates a ApplicationWindowOptionsControl object which is tied to the specified offscreen window. More...
	ApplicationWindowOptionsControl (ApplicationWindowOptionsControl const &in_that)
	The copy constructor creates a ApplicationWindowOptionsControl object that shares the underlying smart-pointer of the source ApplicationWindowOptionsControl. More...
	ApplicationWindowOptionsControl (ApplicationWindowOptionsControl &&in_that)
	The move constructor creates an ApplicationWindowOptionsControl by transferring the underlying impl of the rvalue reference to this ApplicationWindowOptionsControl thereby avoiding a copy and allocation. More...
ApplicationWindowOptionsControl &	operator= (ApplicationWindowOptionsControl &&in_that)
	The move assignment operator transfers the underlying impl of the rvalue reference to this ApplicationWindowOptionsControl thereby avoiding a copy. More...
	~ApplicationWindowOptionsControl ()
	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
ApplicationWindowOptionsControl &	operator= (ApplicationWindowOptionsControl const &in_that)
	Share the underlying smart-pointer of the ApplicationWindowOptionsControl source. 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...
ApplicationWindowOptionsControl &	SetAntiAliasCapable (bool in_state, unsigned int in_samples=4)
	Sets the anti-alias options for this ApplicationWindowOptionsControl. More...
bool	ShowAntiAliasCapable (bool &out_state, unsigned int &out_samples) const
	Shows the whether this application window is anti-alias capable, and if so, how many samples it uses for anti-aliasing. More...
bool	ShowDriver (Window::Driver &out_driver) const
	Shows the driver for the associated application window. More...
bool	ShowWindowHandle (WindowHandle &out_window_handle) const
	Shows the window handle for the associated application window. More...
bool	ShowPlatformData (PlatformData &out_platform_data) const
	Shows the platform specific data for the associated application window. More...
bool	ShowFramebufferRetention (bool &out_retain) const
	Shows the framebuffer retention setting for the associated application window. More...
ApplicationWindowOptionsControl &	SetWindowHandle (WindowHandle in_window_handle)
	Sets the window handle for the associated application window. More...
ApplicationWindowOptionsControl &	SetPlatformData (PlatformData in_platform_data)
	Sets the platform specific data for the associated application window. More...
ApplicationWindowOptionsControl &	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...
ApplicationWindowOptionsControl &	UnsetFallbackFonts ()
	Unsets any fonts currently used as fallback fonts. 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::ApplicationWindowOptionsControl

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

Detailed Description

The HPS::ApplicationWindowOptionsControl class is a smart pointer that is tied to a database object.

It is used to query and manipulate options pertaining to an HPS::ApplicationWindowKey. Default values for the various fields of HPS::ApplicationWindowOptionsControl can be found here.

Constructor & Destructor Documentation

ApplicationWindowOptionsControl() [1/4]

HPS::ApplicationWindowOptionsControl::ApplicationWindowOptionsControl ( ApplicationWindowKey &  in_seg )

explicit

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

Parameters

in_window

The application window which this ApplicationWindowOptionsControl should operate on.

ApplicationWindowOptionsControl() [2/4]

HPS::ApplicationWindowOptionsControl::ApplicationWindowOptionsControl

(

ApplicationWindowOptionsControl const &

in_that

)

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

Parameters

in_that

The source ApplicationWindowOptionsControl to copy.

ApplicationWindowOptionsControl() [3/4]

HPS::ApplicationWindowOptionsControl::ApplicationWindowOptionsControl

(

ApplicationWindowOptionsControl &&

in_that

)

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

Parameters

in_that

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

~ApplicationWindowOptionsControl()

HPS::ApplicationWindowOptionsControl::~ApplicationWindowOptionsControl

(

)

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

ApplicationWindowOptionsControl() [4/4]

HPS::ApplicationWindowOptionsControl::ApplicationWindowOptionsControl ( )

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::ApplicationWindowOptionsControl::ObjectType ( ) const

inlinevirtual

Reimplemented from HPS::Control.

operator=() [1/2]

ApplicationWindowOptionsControl& HPS::ApplicationWindowOptionsControl::operator=

(

ApplicationWindowOptionsControl &&

in_that

)

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

Parameters

in_that

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

Returns

A reference to this ApplicationWindowOptionsControl.

operator=() [2/2]

ApplicationWindowOptionsControl& HPS::ApplicationWindowOptionsControl::operator=

(

ApplicationWindowOptionsControl const &

in_that

)

Share the underlying smart-pointer of the ApplicationWindowOptionsControl source.

Parameters

in_that

The ApplicationWindowOptionsControl source of the assignment.

Returns

A reference to this ApplicationWindowOptionsControl.

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()

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

Sets the anti-alias options for this ApplicationWindowOptionsControl.

Parameters

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

Returns

A reference to this StandAloneWindowOptionsKit.

SetFallbackFonts()

ApplicationWindowOptionsControl& HPS::ApplicationWindowOptionsControl::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.

SetPlatformData()

ApplicationWindowOptionsControl& HPS::ApplicationWindowOptionsControl::SetPlatformData

(

PlatformData

in_platform_data

)

Sets the platform specific data for the associated application window.

Parameters

in_platform_data

Platform specific data for the associated application window.

Returns

A reference to this ApplicationWindowOptionsControl.

SetWindowHandle()

ApplicationWindowOptionsControl& HPS::ApplicationWindowOptionsControl::SetWindowHandle

(

WindowHandle

in_window_handle

)

Sets the window handle for the associated application window.

Used to rebind the application window to a new window handle.

Parameters

in_window_handle

Handle to the new WindowHandle that Visualize will draw into.

Returns

A reference to this ApplicationWindowOptionsControl.

ShowAntiAliasCapable()

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

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

Parameters

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

Returns

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

ShowDriver()

bool HPS::ApplicationWindowOptionsControl::ShowDriver

(

Window::Driver &

out_driver

)

const

Shows the driver for the associated application window.

Parameters

out_driver

The driver for the associated application window.

Returns

true if a driver was set, false otherwise.

ShowFallbackFonts()

size_t HPS::ApplicationWindowOptionsControl::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.

ShowFramebufferRetention()

bool HPS::ApplicationWindowOptionsControl::ShowFramebufferRetention

(

bool &

out_retain

)

const

Shows the framebuffer retention setting for the associated application window.

Parameters

out_retain

The framebuffer retention setting for the associated application window.

Returns

true if framebuffer retention option was set, false otherwise.

ShowPlatformData()

bool HPS::ApplicationWindowOptionsControl::ShowPlatformData

(

PlatformData &

out_platform_data

)

const

Shows the platform specific data for the associated application window.

Parameters

out_platform_data

The platform specific data for the associated application window.

Returns

true if platform specific data was set, false otherwise.

ShowWindowHandle()

bool HPS::ApplicationWindowOptionsControl::ShowWindowHandle

(

WindowHandle &

out_window_handle

)

const

Shows the window handle for the associated application window.

Parameters

out_window_handle

The window handle for the associated application window.

Returns

true if a window handle was set, false otherwise.

Type()

virtual HPS::Type HPS::ApplicationWindowOptionsControl::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()

ApplicationWindowOptionsControl& HPS::ApplicationWindowOptionsControl::UnsetFallbackFonts

(

)

Unsets any fonts currently used as fallback fonts.

Member Data Documentation

staticType

const HPS::Type HPS::ApplicationWindowOptionsControl::staticType = HPS::Type::ApplicationWindowOptionsControl

static

---

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

• hps.h