HPS::OffScreenWindowOptionsControl Class Reference

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

#include <hps.h>

Inheritance diagram for HPS::OffScreenWindowOptionsControl:

Collaboration diagram for HPS::OffScreenWindowOptionsControl:

Public Member Functions
	OffScreenWindowOptionsControl (OffScreenWindowKey &in_seg)
	This constructor creates a OffScreenWindowOptionsControl object which is tied to the specified offscreen window. More...
	OffScreenWindowOptionsControl (OffScreenWindowOptionsControl const &in_that)
	The copy constructor creates a OffScreenWindowOptionsControl object that shares the underlying smart-pointer of the source OffScreenWindowOptionsControl. More...
	OffScreenWindowOptionsControl (OffScreenWindowOptionsControl &&in_that)
	The move constructor creates an OffScreenWindowOptionsControl by transferring the underlying impl of the rvalue reference to this OffScreenWindowOptionsControl thereby avoiding a copy and allocation. More...
OffScreenWindowOptionsControl &	operator= (OffScreenWindowOptionsControl &&in_that)
	The move assignment operator transfers the underlying impl of the rvalue reference to this OffScreenWindowOptionsControl thereby avoiding a copy. More...
	~OffScreenWindowOptionsControl ()
virtual HPS::Type	Type () const
	This function returns the true type of the underlying object. More...
HPS::Type	ObjectType () const
OffScreenWindowOptionsControl &	operator= (OffScreenWindowOptionsControl const &in_that)
	Share the underlying smart-pointer of the OffScreenWindowOptionsControl source. More...
OffScreenWindowOptionsControl &	SetSize (unsigned int in_width, unsigned int in_height)
	Sets the width and height in pixels of the associated offscreen window. More...
OffScreenWindowOptionsControl &	SetNativeFormat (Window::ImageFormat in_format, float in_quality=1.0f)
	Sets the native image format to store data in. More...
OffScreenWindowOptionsControl &	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...
OffScreenWindowOptionsControl &	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 the associated offscreen window. More...
OffScreenWindowOptionsControl &	SetAntiAliasCapable (bool in_state, unsigned int in_samples=4)
	Sets the anti-alias options for this OffScreenWindowOptionsControl. More...
bool	ShowAntiAliasCapable (bool &out_state, unsigned int &out_samples) const
	Shows the whether this offscreen window is anti-alias capable, and if so, how many samples it uses for anti-aliasing. More...
bool	ShowSize (unsigned int &out_width, unsigned int &out_height) const
	Shows the width and height in pixels of the associated offscreen window. More...
bool	ShowImage (Image::Format in_format, ImageKit &out_image) const
	Shows the contents of this offscreen window into the provided ImageKit in the specified format. More...
bool	ShowImage (ByteArray &out_bytes) const
	Shows the image bytes in the native format for this OffScreenWindow. More...
bool	ShowHardwareResident (bool &out_state) const
	Shows the hardware resident option of the associated offscreen window. More...
bool	ShowOpacity (bool &out_state, float &out_opacity) const
	Shows the opacity of the associated offscreen window. More...
bool	ShowNativeFormat (Window::ImageFormat &out_format, float &out_quality) const
	Shows the native format and quality of the associated offscreen window. More...
bool	ShowFramebufferRetention (bool &out_retain) const
	Shows the framebuffer retention setting for the associated offscreen 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::OffScreenWindowOptionsControl

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

Detailed Description

The HPS::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 HPS::OffScreenWindowOptionsControl.

Constructor & Destructor Documentation

OffScreenWindowOptionsControl() [1/4]

HPS::OffScreenWindowOptionsControl::OffScreenWindowOptionsControl ( OffScreenWindowKey &  in_seg )

explicit

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

Parameters

in_window

The offscreen window which this OffScreenWindowOptionsControl should operate on.

OffScreenWindowOptionsControl() [2/4]

HPS::OffScreenWindowOptionsControl::OffScreenWindowOptionsControl

(

OffScreenWindowOptionsControl const &

in_that

)

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

Parameters

in_that

The source OffScreenWindowOptionsControl to copy.

OffScreenWindowOptionsControl() [3/4]

HPS::OffScreenWindowOptionsControl::OffScreenWindowOptionsControl

(

OffScreenWindowOptionsControl &&

in_that

)

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

Parameters

in_that

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

~OffScreenWindowOptionsControl()

HPS::OffScreenWindowOptionsControl::~OffScreenWindowOptionsControl

(

)

OffScreenWindowOptionsControl() [4/4]

HPS::OffScreenWindowOptionsControl::OffScreenWindowOptionsControl ( )

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

inlinevirtual

Reimplemented from HPS::Control.

operator=() [1/2]

OffScreenWindowOptionsControl& HPS::OffScreenWindowOptionsControl::operator=

(

OffScreenWindowOptionsControl &&

in_that

)

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

Parameters

in_that

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

Returns

A reference to this OffScreenWindowOptionsControl.

operator=() [2/2]

OffScreenWindowOptionsControl& HPS::OffScreenWindowOptionsControl::operator=

(

OffScreenWindowOptionsControl const &

in_that

)

Share the underlying smart-pointer of the OffScreenWindowOptionsControl source.

Parameters

in_that

The OffScreenWindowOptionsControl source of the assignment.

Returns

A reference to this OffScreenWindowOptionsControl.

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

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

Sets the anti-alias options for this OffScreenWindowOptionsControl.

Parameters

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

Returns

A reference to this OffScreenWindowOptionsControl.

SetFallbackFonts()

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

SetNativeFormat()

OffScreenWindowOptionsControl& HPS::OffScreenWindowOptionsControl::SetNativeFormat	(	Window::ImageFormat	in_format,
		float	in_quality = 1.0f
	)

Sets the native image format to store data in.

Parameters

in_format	Format image data will be stored in.
in_quality	The compression quality for the image data (when applicable).

Returns

A reference to this OffScreenWindowOptionsControl.

SetSize()

OffScreenWindowOptionsControl& HPS::OffScreenWindowOptionsControl::SetSize	(	unsigned int	in_width,
		unsigned int	in_height
	)

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

Parameters

in_width	The width in pixels of the associated offscreen window.
in_height	The height in pixels of the associated offscreen window.

Returns

A reference to this OffScreenWindowOptionsControl.

ShowAntiAliasCapable()

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

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

Parameters

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

Returns

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

ShowDriver()

bool HPS::OffScreenWindowOptionsControl::ShowDriver

(

Window::Driver &

out_driver

)

const

Shows the driver for the associated offscreen window.

Parameters

out_driver

The driver for the associated offscreen window.

Returns

true if a driver was set, false otherwise.

ShowFallbackFonts()

size_t HPS::OffScreenWindowOptionsControl::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::OffScreenWindowOptionsControl::ShowFramebufferRetention

(

bool &

out_retain

)

const

Shows the framebuffer retention setting for the associated offscreen window.

Parameters

out_retain

The framebuffer retention setting for the associated offscreen window.

Returns

true if framebuffer retention option was set, false otherwise.

ShowHardwareResident()

bool HPS::OffScreenWindowOptionsControl::ShowHardwareResident

(

bool &

out_state

)

const

Shows the hardware resident option of the associated offscreen window.

Parameters

out_state

Whether 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.

ShowImage() [1/2]

bool HPS::OffScreenWindowOptionsControl::ShowImage	(	Image::Format	in_format,
		ImageKit &	out_image
	)		const

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

Parameters

in_format	The format of the image to generate.
out_image	The contents of this offscreen window as an image in the specified format.

Returns

true if the shown image is valid, false otherwise.

ShowImage() [2/2]

bool HPS::OffScreenWindowOptionsControl::ShowImage

(

ByteArray &

out_bytes

)

const

Shows the image bytes in the native format for this OffScreenWindow.

Parameters

in_quality	Desired quality for compressed image formats.
out_bytes	Image data as an array of bytes.

Returns

true if the shown image is valid, false otherwise.

ShowNativeFormat()

bool HPS::OffScreenWindowOptionsControl::ShowNativeFormat	(	Window::ImageFormat &	out_format,
		float &	out_quality
	)		const

Shows the native format and quality of the associated offscreen window.

Parameters

out_format	Format image data will be stored in.
out_quality	The compression quality for the image data (when applicable).

Returns

true if a native format option was set, false otherwise.

ShowOpacity()

bool HPS::OffScreenWindowOptionsControl::ShowOpacity	(	bool &	out_state,
		float &	out_opacity
	)		const

Shows the opacity of the associated offscreen window.

Parameters

out_state	Whether the offscreen window supports opacity in the window background.
out_opacity	The opacity value that will be applied when rendering the window background.

Returns

true if an opacity option was set, false otherwise.

ShowSize()

bool HPS::OffScreenWindowOptionsControl::ShowSize	(	unsigned int &	out_width,
		unsigned int &	out_height
	)		const

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

Parameters

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

Returns

true if a height and width were set, false otherwise.

Type()

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

OffScreenWindowOptionsControl& HPS::OffScreenWindowOptionsControl::UnsetFallbackFonts

(

)

Unsets any fonts currently used as fallback fonts.

Member Data Documentation

staticType

const HPS::Type HPS::OffScreenWindowOptionsControl::staticType = HPS::Type::OffScreenWindowOptionsControl

static

---

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

• hps.h