The HPS::CameraKit class is a user space object, useful for carrying a group of attribute settings. More...

#include <hps.h>

Inheritance diagram for HPS::CameraKit:

Collaboration diagram for HPS::CameraKit:

Public Member Functions
	CameraKit ()
	Initializes an empty kit. More...

	CameraKit (const CameraKit &in_kit)
	The copy constructor creates a new CameraKit object that contains the same settings as the source object. More...

	CameraKit (CameraKit &&in_that)
	The move constructor creates a CameraKit by transferring the underlying impl of the rvalue reference to this CameraKit thereby avoiding a copy and allocation. More...

CameraKit &	operator= (CameraKit &&in_that)
	The move assignment operator transfers the underlying impl of the rvalue reference to this CameraKit thereby avoiding a copy. More...

virtual	~CameraKit ()
	Destroy this kit. More...

HPS::Type	ObjectType () const

void	Set (CameraKit const &in_kit)
	Copies all settings from the source CameraKit into this object. More...

void	Show (CameraKit &out_kit) const
	Copies all settings from this CameraKit into the given CameraKit. More...

CameraKit &	operator= (CameraKit const &in_kit)
	Copies the source CameraKit into this object. More...

bool	Empty () const
	Indicates whether this object has any values set on it. More...

bool	Equals (CameraKit const &in_kit) const
	Check if the source CameraKit is equivalent to this object. More...

bool	operator== (CameraKit const &in_kit) const
	Check if the source CameraKit is equivalent to this object. More...

bool	operator!= (CameraKit const &in_kit) const
	Check if the source CameraKit is not equivalent to this object. More...

CameraKit &	SetUpVector (Vector const &in_up)
	Sets a vector that defines the vertical up direction of the camera. More...

CameraKit &	SetPosition (Point const &in_position)
	Sets the location of the camera. More...

CameraKit &	SetTarget (Point const &in_target)
	Sets the location that the camera is pointed at. More...

CameraKit &	SetProjection (Camera::Projection in_type, float in_oblique_y_skew=0.0f, float in_oblique_x_skew=0.0f)
	Sets the camera projection type and the oblique skew, if any. More...

CameraKit &	SetField (float in_width, float in_height)
	Sets the camera field. More...

CameraKit &	SetNearLimit (float const in_limit)
	Sets the near_limit to in_limit that defines the near limit of the camera. More...

CameraKit &	UnsetUpVector ()
	Removes the camera up-vector setting. More...

CameraKit &	UnsetPosition ()
	Removes the camera position setting. More...

CameraKit &	UnsetTarget ()
	Removes the camera target setting. More...

CameraKit &	UnsetProjection ()
	Removes the camera projection setting. More...

CameraKit &	UnsetField ()
	Removes the camera field setting. More...

CameraKit &	UnsetNearLimit ()
	Removes the camera near limit setting. More...

CameraKit &	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_y_skew, float &out_oblique_x_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 near limit field. More...

CameraKit &	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...

CameraKit &	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...

CameraKit &	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...

CameraKit &	Roll (float in_theta)
	Spins the camera around its target in_theta degrees counter-clockwise (the scene will appear to move clockwise). More...

CameraKit &	Zoom (float in_zoom)
	Adjusts the field of view by dividing the width and height by the input value. More...

virtual HPS::Type	Type () const
	This function returns the true type of the underlying object. 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
static CameraKit	GetDefault ()
	Creates a CameraKit which contains the default settings. More...

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

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

Detailed Description

The HPS::CameraKit class is a user space object, useful for carrying a group of attribute settings.

Calling HPS::CameraKit::GetDefault() will return a kit with values found in this table.

Constructor & Destructor Documentation

◆ CameraKit() [1/3]

HPS::CameraKit::CameraKit ( )

Initializes an empty kit.

◆ CameraKit() [2/3]

HPS::CameraKit::CameraKit ( const CameraKit & in_kit )

The copy constructor creates a new CameraKit object that contains the same settings as the source object.

Parameters

in_kit The source object to copy.

◆ CameraKit() [3/3]

HPS::CameraKit::CameraKit ( CameraKit && in_that )

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

Parameters

in_that An rvalue reference to a CameraKit to take the impl from.

◆ ~CameraKit()

virtual HPS::CameraKit::~CameraKit ( )

virtual

Destroy this kit.

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

CameraKit& HPS::CameraKit::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()

bool HPS::CameraKit::Empty ( ) const

virtual

Indicates whether this object has any values set on it.

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

Reimplemented from HPS::Object.

◆ Equals()

bool HPS::CameraKit::Equals ( CameraKit const & in_kit ) const

Check if the source CameraKit is equivalent to this object.

Parameters

in_kit The source CameraKit to compare to this object.

Returns: true if the objects are equivalent, false otherwise.

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

◆ GetDefault()

static CameraKit HPS::CameraKit::GetDefault ( )

static

Creates a CameraKit which contains the default settings.

The returned object will not necessarily have values set for every option, but it will have settings for those options where it is reasonable to have a default.

Returns: A CameraKit with the default settings.

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

inlinevirtual

Reimplemented from HPS::Kit.

Here is the call graph for this function:

◆ operator!=()

bool HPS::CameraKit::operator!= ( CameraKit const & in_kit ) const

Check if the source CameraKit is not equivalent to this object.

Parameters

in_kit The source CameraKit to compare to this object.

Returns: true if the objects are not equivalent, false otherwise.

◆ operator=() [1/2]

CameraKit& HPS::CameraKit::operator= ( CameraKit && in_that )

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

Parameters

in_that An rvalue reference to a CameraKit to take the impl from.

Returns: A reference to this CameraKit.

◆ operator=() [2/2]

CameraKit& HPS::CameraKit::operator= ( CameraKit const & in_kit )

Copies the source CameraKit into this object.

Parameters

in_kit The source CameraKit to copy.

Returns: A reference to this object.

◆ operator==()

bool HPS::CameraKit::operator== ( CameraKit const & in_kit ) const

Check if the source CameraKit is equivalent to this object.

Parameters

in_kit The source CameraKit to compare to this object.

Returns: true if the objects are equivalent, false otherwise.

◆ Orbit()

CameraKit& HPS::CameraKit::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()

CameraKit& HPS::CameraKit::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()

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

◆ Set()

void HPS::CameraKit::Set ( CameraKit const & in_kit )

Copies all settings from the source CameraKit into this object.

Parameters

in_kit The source CameraKit to copy.

◆ SetField()

CameraKit& HPS::CameraKit::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: Default value

◆ SetNearLimit()

CameraKit& HPS::CameraKit::SetNearLimit ( float const in_limit )

Sets the near_limit to in_limit 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 choose a wlimit based on the precision of the zbuffer as reported by the driver.

Parameters

in_limit The value to set the near limit to

Returns: A reference to this object.

◆ SetPosition()

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

◆ SetProjection()

CameraKit& HPS::CameraKit::SetProjection	(	Camera::Projection	in_type,
		float	in_oblique_y_skew = `0.0f`,
		float	in_oblique_x_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: Default value

◆ SetTarget()

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

◆ SetUpVector()

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

◆ Show()

void HPS::CameraKit::Show ( CameraKit & out_kit ) const

Copies all settings from this CameraKit into the given CameraKit.

Parameters

out_kit The CameraKit to populate with the contents of this object.

◆ ShowField()

bool HPS::CameraKit::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::CameraKit::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::CameraKit::ShowNearLimit ( float & out_near_limit ) const

Shows the near limit field.

Parameters

out_near_limit The near limit of the camera field.

Returns: true if the setting is valid, false otherwise.

◆ ShowPosition()

bool HPS::CameraKit::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::CameraKit::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::CameraKit::ShowProjection	(	Camera::Projection &	out_type,
		float &	out_oblique_y_skew,
		float &	out_oblique_x_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::CameraKit::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::CameraKit::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::CameraKit::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::Kit::Type ( ) const

inlinevirtualinherited

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::Object.

◆ UnsetEverything()

CameraKit& HPS::CameraKit::UnsetEverything ( )

Removes all settings from this object.

Returns: A reference to this object.

◆ UnsetField()

CameraKit& HPS::CameraKit::UnsetField ( )

Removes the camera field setting.

Returns: A reference to this object.

◆ UnsetNearLimit()

CameraKit& HPS::CameraKit::UnsetNearLimit ( )

Removes the camera near limit setting.

Returns: A reference to this object.

◆ UnsetPosition()

CameraKit& HPS::CameraKit::UnsetPosition ( )

Removes the camera position setting.

Returns: A reference to this object.

◆ UnsetProjection()

CameraKit& HPS::CameraKit::UnsetProjection ( )

Removes the camera projection setting.

Returns: A reference to this object.

◆ UnsetTarget()

CameraKit& HPS::CameraKit::UnsetTarget ( )

Removes the camera target setting.

Returns: A reference to this object.

◆ UnsetUpVector()

CameraKit& HPS::CameraKit::UnsetUpVector ( )

Removes the camera up-vector setting.

Returns: A reference to this object.

◆ Zoom()

CameraKit& HPS::CameraKit::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::CameraKit::staticType = HPS::Type::CameraKit

static

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

hps.h

Public Member Functions

Static Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ CameraKit() [1/3]

◆ CameraKit() [2/3]

◆ CameraKit() [3/3]

◆ ~CameraKit()

Member Function Documentation

◆ ClassID()

◆ Dolly()

◆ Empty()

◆ Equals()

◆ GetClassID()

◆ GetDefault()

◆ GetInstanceID()

◆ HasType()

◆ ObjectType()

◆ operator!=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ Orbit()

◆ Pan()

◆ Reset()

◆ Roll()

◆ Set()

◆ SetField()

◆ SetNearLimit()

◆ SetPosition()

◆ SetProjection()

◆ SetTarget()

◆ SetUpVector()

◆ Show()

◆ ShowField()

◆ ShowHeight()

◆ ShowNearLimit()

◆ ShowPosition()

◆ ShowProjection() [1/2]

◆ ShowProjection() [2/2]

◆ ShowTarget()

◆ ShowUpVector()

◆ ShowWidth()

◆ Type()

◆ UnsetEverything()

◆ UnsetField()

◆ UnsetNearLimit()

◆ UnsetPosition()

◆ UnsetProjection()

◆ UnsetTarget()

◆ UnsetUpVector()

◆ Zoom()

Member Data Documentation

◆ staticType