HPS::CameraControl Class Reference

#include <hps.h>

Inheritance diagram for HPS::CameraControl:

Collaboration diagram for HPS::CameraControl:

Public Member Functions
	CameraControl (SegmentKey &in_seg)
	Initializes a control tied to the segment in_seg. More...
	CameraControl (CameraControl const &in_that)
	Initializes a control tied to the same object as in_that. More...
	CameraControl (CameraControl &&in_that)
	The move constructor creates a CameraControl by transferring the underlying impl of the rvalue reference to this CameraControl thereby avoiding a copy and allocation. More...
CameraControl &	operator= (CameraControl &&in_that)
	The move assignment operator transfers the underlying impl of the rvalue reference to this CameraControl thereby avoiding a copy. More...
	~CameraControl ()
	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
CameraControl &	operator= (CameraControl const &in_that)
	Share the underlying smart-pointer of the CameraControl source. More...
CameraControl &	SetUpVector (Vector const &in_up)
	Sets a vector that defines the vertical up direction of the camera. More...
CameraControl &	SetPosition (Point const &in_position)
	Sets the location of the camera. More...
CameraControl &	SetTarget (Point const &in_target)
	Sets the location that the camera is pointed at. More...
CameraControl &	SetProjection (Camera::Projection in_type, float in_oblique_x_skew=0.0f, float in_oblique_y_skew=0.0f)
	Sets the camera projection type and the oblique skew, if any. More...
CameraControl &	SetField (float in_width, float in_height)
	Sets the camera field. More...
CameraControl &	SetNearLimit (float in_double)
	Sets the near_limit to in_double that defines the near limit of the camera. More...
CameraControl &	UnsetEverything ()
	Removes all settings from this object. More...
bool	ShowUpVector (Vector &out_up_vector) const
	Shows the camera up-vector. More...
bool	ShowPosition (Point &out_position) const
	Shows the camera position. More...
bool	ShowTarget (Point &out_target) const
	Shows the camera target. More...
bool	ShowProjection (Camera::Projection &out_type) const
	Shows the camera projection type. More...
bool	ShowProjection (Camera::Projection &out_type, float &out_oblique_x_skew, float &out_oblique_y_skew) const
	Shows the camera projection type and the oblique skew, if any. More...
bool	ShowWidth (float &out_width) const
	Shows the width of the camera field. More...
bool	ShowHeight (float &out_height) const
	Shows the height of the camera field. More...
bool	ShowField (float &out_width, float &out_height) const
	Shows the camera field. More...
bool	ShowNearLimit (float &out_near_limit) const
	Shows the camera near limit. More...
CameraControl &	Dolly (float in_x_dir, float in_up, float in_forward)
	Moves the camera position and target the specified amount but maintains the up vector and field. More...
CameraControl &	Orbit (float in_theta, float in_phi)
	Moves the camera around the target in_theta degrees to the right and in_phi degrees up. More...
CameraControl &	Pan (float in_theta, float in_phi)
	Pivots the camera on its location in_theta degrees to the right and in_phi degrees up. More...
CameraControl &	Roll (float in_theta)
	Spins the camera around its target in_theta degrees counter-clockwise (the scene will appear to move clockwise). More...
CameraControl &	Zoom (float in_zoom)
	Adjusts the field of view by dividing the width and height by the input value. 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::CameraControl

Private Member Functions
	CameraControl ()
	Private default constructor to prevent instantiation without a segment. More...

Detailed Description

The HPS::CameraControl class is a smart pointer that is tied to a database object. The CameraControl is used to manipulate the viewpoint, or camera, in a scene. Using this control, the view position, orientation, target, and aspect ratio of a segment's camera can be set. Cameras are considered segment attributes, but unlink other attributes, they inherit as a group down the segment hierarchy. This table lists default values for the various segment attributes accessible from HPS::CameraControl.

Constructor & Destructor Documentation

CameraControl() [1/4]

HPS::CameraControl::CameraControl ( SegmentKey &  in_seg )

explicit

Initializes a control tied to the segment in_seg.

CameraControl() [2/4]

HPS::CameraControl::CameraControl

(

CameraControl const &

in_that

)

Initializes a control tied to the same object as in_that.

CameraControl() [3/4]

HPS::CameraControl::CameraControl

(

CameraControl &&

in_that

)

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

Parameters

in_that

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

~CameraControl()

HPS::CameraControl::~CameraControl

(

)

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

CameraControl() [4/4]

HPS::CameraControl::CameraControl ( )

private

Private default constructor to prevent instantiation without a segment.

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.

Dolly()

CameraControl& HPS::CameraControl::Dolly	(	float	in_x_dir,
		float	in_up,
		float	in_forward
	)

Moves the camera position and target the specified amount but maintains the up vector and field.

If a complete camera is not already set up, one will be populated with default values before dollying.

Parameters

in_x_dir	The number of world-space units to move the camera in the x-direction.
in_up	The number of world-space units to move the camera up, or if negative, down.
in_forward	The number of world-space units to move the camera toward the target, or if negative, away from the target.

Returns

A reference to this object.

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

inlinevirtual

Reimplemented from HPS::Control.

operator=() [1/2]

CameraControl& HPS::CameraControl::operator=

(

CameraControl &&

in_that

)

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

Parameters

in_that

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

Returns

A reference to this CameraControl.

operator=() [2/2]

CameraControl& HPS::CameraControl::operator=

(

CameraControl const &

in_that

)

Share the underlying smart-pointer of the CameraControl source.

Parameters

in_that

The CameraControl source of the assignment.

Returns

A reference to this CameraControl.

Orbit()

CameraControl& HPS::CameraControl::Orbit	(	float	in_theta,
		float	in_phi
	)

Moves the camera around the target in_theta degrees to the right and in_phi degrees up.

The target and field are maintained but position and up_vector may change. If a complete camera is not already set up, one will be populated with default values before orbiting.

Parameters

in_theta	The number of degrees to move the the camera position to the right.
in_phi	The number of degrees to move the the camera position up.

Returns

A reference to this object.

Pan()

CameraControl& HPS::CameraControl::Pan	(	float	in_theta,
		float	in_phi
	)

Pivots the camera on its location in_theta degrees to the right and in_phi degrees up.

The position and field remain unchanged while the target and up vector may change. If a complete camera is not already set up, one will be populated with default values before panning.

Parameters

in_theta	The number of degrees to move the the camera target to the right.
in_phi	The number of degrees to move the the camera target up.

Returns

A reference to this object.

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.

Roll()

CameraControl& HPS::CameraControl::Roll

(

float

in_theta

)

Spins the camera around its target in_theta degrees counter-clockwise (the scene will appear to move clockwise).

The position, field, and target are unchanged while the up-vector may change. If a complete camera is not already set up, one will be populated with default values before rolling.

Parameters

in_theta

The number of degrees to roll the camera.

Returns

A reference to this object.

SetField()

CameraControl& HPS::CameraControl::SetField	(	float	in_width,
		float	in_height
	)

Sets the camera field.

Parameters

in_width	The width of the camera field, in object-space units.
in_height	The height of the camera field, in object-space units.

Returns

A reference to this object.

See also

camera field

SetNearLimit()

CameraControl& HPS::CameraControl::SetNearLimit

(

float

in_double

)

Sets the near_limit to in_double that defines the near limit of the camera.

A value approaching 0.0 will place it close to the camera position (at the cost of poor z-buffer precision), whereas a value approaching 1.0 will place it near the camera target (at the cost of clipping away anything closer than the target). A value exactly equal to 0 will let HOOPS Visualize choose a limit based on the precision of the zbuffer as reported by the driver.

Parameters

in_double

The value to set the near limit to

Returns

A reference to this object.

See also

camera near limit

SetPosition()

CameraControl& HPS::CameraControl::SetPosition

(

Point const &

in_position

)

Sets the location of the camera.

Parameters

in_position

The location of the camera.

Returns

A reference to this object.

See also

camera position

SetProjection()

CameraControl& HPS::CameraControl::SetProjection	(	Camera::Projection	in_type,
		float	in_oblique_x_skew = 0.0f,
		float	in_oblique_y_skew = 0.0f
	)

Sets the camera projection type and the oblique skew, if any.

Parameters

in_type	The type of camera projection.
in_oblique_x_skew	The oblique skew in the horizontal direction.
in_oblique_y_skew	The oblique skew in the vertical direction.

Returns

A reference to this object.

See also

camera target

SetTarget()

CameraControl& HPS::CameraControl::SetTarget

(

Point const &

in_target

)

Sets the location that the camera is pointed at.

Parameters

in_target

The location that the camera is pointed at.

Returns

A reference to this object.

See also

camera position

SetUpVector()

CameraControl& HPS::CameraControl::SetUpVector

(

Vector const &

in_up

)

Sets a vector that defines the vertical up direction of the camera.

Parameters

in_up

A vector that defines the vertical up direction of the camera.

Returns

A reference to this object.

See also

camera up vector

ShowField()

bool HPS::CameraControl::ShowField	(	float &	out_width,
		float &	out_height
	)		const

Shows the camera field.

Parameters

out_width	The width of the camera field, in object-space units.
out_height	The height of the camera field, in object-space units.

Returns

true if the setting is valid, false otherwise.

ShowHeight()

bool HPS::CameraControl::ShowHeight

(

float &

out_height

)

const

Shows the height of the camera field.

Parameters

out_height

The height of the camera field, in object-space units.

Returns

true if the setting is valid, false otherwise.

ShowNearLimit()

bool HPS::CameraControl::ShowNearLimit

(

float &

out_near_limit

)

const

Shows the camera near limit.

Parameters

out_width

The near limit of the camera field.

Returns

true if the setting is valid, false otherwise.

ShowPosition()

bool HPS::CameraControl::ShowPosition

(

Point &

out_position

)

const

Shows the camera position.

Parameters

out_position

the location of the camera.

Returns

true if the setting is valid, false otherwise.

ShowProjection() [1/2]

bool HPS::CameraControl::ShowProjection

(

Camera::Projection &

out_type

)

const

Shows the camera projection type.

Parameters

out_type

The type of camera projection.

Returns

true if the setting is valid, false otherwise.

ShowProjection() [2/2]

bool HPS::CameraControl::ShowProjection	(	Camera::Projection &	out_type,
		float &	out_oblique_x_skew,
		float &	out_oblique_y_skew
	)		const

Shows the camera projection type and the oblique skew, if any.

Parameters

out_type	The type of camera projection.
out_oblique_x_skew	The oblique skew in the horizontal direction.
out_oblique_y_skew	The oblique skew in the vertical direction.

Returns

true if the setting is valid, false otherwise.

ShowTarget()

bool HPS::CameraControl::ShowTarget

(

Point &

out_target

)

const

Shows the camera target.

Parameters

out_target

the location that the camera is pointed at.

Returns

true if the setting is valid, false otherwise.

ShowUpVector()

bool HPS::CameraControl::ShowUpVector

(

Vector &

out_up_vector

)

const

Shows the camera up-vector.

Parameters

out_up_vector

A vector that defines the vertical up direction of the camera.

Returns

true if the setting is valid, false otherwise.

ShowWidth()

bool HPS::CameraControl::ShowWidth

(

float &

out_width

)

const

Shows the width of the camera field.

Parameters

out_width

The width of the camera field, in object-space units.

Returns

true if the setting is valid, false otherwise.

Type()

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

UnsetEverything()

CameraControl& HPS::CameraControl::UnsetEverything

(

)

Removes all settings from this object.

Unlike other attributes, it is not possible to unset just a single field of a camera. If the control is attached to a WindowKey this function restores the default settings of this control as specified by CameraKit::GetDefault().

Returns

A reference to this object.

Zoom()

CameraControl& HPS::CameraControl::Zoom

(

float

in_zoom

)

Adjusts the field of view by dividing the width and height by the input value.

Numbers greater than one will have the effect of making things on screen appear larger. Numbers between zero and one will have the opposite effect. Only the field is affected. If a complete camera is not already set up, one will be populated with default values before zooming.

Parameters

in_zoom

The zoom scale factor.

Returns

A reference to this object.

Member Data Documentation

staticType

const HPS::Type HPS::CameraControl::staticType = HPS::Type::CameraControl

static

---

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

• hps.h