VSN::PrCameraZoom Class Reference

PrCameraZoom class provides scene zooming about its center. More...

#include <vsn_prcamerazoom.h>

Inheritance diagram for VSN::PrCameraZoom:

Collaboration diagram for VSN::PrCameraZoom:

Public Member Functions
bool	IsZoomWheelReversed () const
	Return revert mouse wheel direction.
void	SetZoomWheelReverse (bool bReverse)
	Set mouse wheel direction.
float	GetZoomLimit () const
	Return the maximum zoom value for the camera. Value in units of object space.
void	SetZoomLimit (float zoomlimit)
	Set the maximum zoom value for a camera. It guarantees that the window always views more than this number of units. More...
void	SetZoomLimit ()
	Performs an automatic calculation of the zoom limit based off of the bounding box of the scene.
Public Member Functions inherited from VSN::PrAbstractCamera
	PrAbstractCamera (GraphicsScene *pGraphicsScene, Node *parent=nullptr)
	Default constructor.
virtual	~PrAbstractCamera ()
	Destructor.
bool	IsActive () const
	Returns true if the process is active.
bool	IsActiveKeyboard () const
	Returns true if the specified keys are active.
float	GetLinearSpeed () const
	Returns the current linear speed of the camera process. The linear speed defines a speed of camera move.
void	SetLinearSpeed (float linearSpeed)
	Sets the linear speed of the camera process. The linear speed defines a speed of camera move.
Public Member Functions inherited from VSN::Process
virtual	~Process ()
	Destructor.
Viewport *	GetViewport () const
	NO TRANSLATION.
virtual void	SetViewport (Viewport *pViewport)
	NO TRANSLATION.
GraphicsScene *	GetGraphicsScene () const
	NO TRANSLATION.
Public Member Functions inherited from VSN::Essence
	Essence (Node *pParent=nullptr)
	Default constructor setting parent node.
virtual	~Essence ()
	Destructor.
void	AddFeature (Feature *pFeature)
	Adds new pointer to Feature.
void	RemoveFeature (Feature *pFeature)
	Removes specified pointer to Feature.
FeatureVector	GetFeatures () const
	Returns feature instance list to which Essence refers.
Essence *	GetParentEssence () const
	Returns pointer to Essence parent instance.
Public Member Functions inherited from VSN::Node
	Node (Node *pParent=nullptr)
	Constructor with parent.
virtual	~Node ()
	Destructor.
NodeKey	GetUniqueKey () const
	Returns key identifing Node instance.
void	SetUniqueKey (const NodeKey &key)
	Sets the unique key for the instance.
NodeKey	GetCustomKey () const
	Returns custom key identifing Node instance.
void	SetCustomKey (const NodeKey &key)
	Sets the custom unique key for the instance.
Node *	GetParentNode () const
	Returns pointer to the parent object or nullptr if no parent.
bool	IsEnabled () const
	Returns the Node enabled flag. By default, the flag is always on.
ObjectList< Node * >	GetChildNodes () const
	Return an array of child nodes for this node.
void	SetParent (Node *pParent)
	Sets parent object to the object.
bool	IsNotificationsBlocked () const
	True if notifications are blocked, otherwise, False.
bool	SetBlockNotifications (bool block)
	Sets blocking of notifications and returns the previous blocking value.
Public Member Functions inherited from VSN::Object
	Object (Object *pParent=nullptr)
	Default constructor. More...
virtual	~Object ()
	Destructor.
void	SetParent (Object *pParent)
	NO TRANSLATION.
Mutex *	GetMutex ()
	Object mutex.
String	GetObjectName () const
	Returns name.
void	SetObjectName (const String &name)
	Sets name.
bool	IsControlType () const
	TRANSLATION.
Object *	GetParent () const
	NO TRANSLATION.
Variant	GetProperty (const String &name) const
	NO TRANSLATION.
bool	IsSignalsBlocked () const
	NO TRANSLATION.
bool	SetBlockSignals (bool bBlock)
	NO TRANSLATION.
void	AddEventListener (Object *pObject)
	NO TRANSLATION.
void	RemoveEventListener (Object *pObject)
	NO TRANSLATION.
Object *	GetSender () const
	NO TRANSLATION.
Thread *	GetThread () const
	NO TRANSLATION.
void	BindWithThread (Thread *thread)
	NO TRANSLATION.
int	StartTimer (int interval, TimerType timerType=tt_CoarseTimer)
	NO TRANSLATION.
void	KillTimer (int id)
	NO TRANSLATION.
const ObjectList< Object * > &	GetChildren () const
	NO TRANSLATION.
template<typename T >
T	FindChild (const String &objName=String()) const
	NO TRANSLATION.
template<typename T >
ObjectList< T >	FindChildren (const String &objName=String(), VSN::ChildFindingPolicies policies=VSN::FindAllNestedChildren) const
	NO TRANSLATION.
Public Member Functions inherited from VSN::BasicObject
	BasicObject ()
	Default constructor.
virtual	~BasicObject ()
	Destructor.

Protected Member Functions
	PrCameraZoom (GraphicsScene *pGraphicsScene, Node *pParent=nullptr)
	Default constructor.
virtual	~PrCameraZoom ()
	Destructor.
bool	IsZoomWheel () const
	NO TRANSLATION.
void	SetZoomWheel (bool bWheel)
	NO TRANSLATION.
virtual void	Activate () final
	Activates the process.
virtual void	Deactivate () final
	Deactivates the process.
virtual void	MouseMove (float dt) final
	Processes the mouse move event.
virtual void	MouseWheel (const PointI &pnt, int delta) final
	Handling the mouse wheel motion event.
Protected Member Functions inherited from VSN::PrAbstractCamera
	PrAbstractCamera (PrAbstractCameraPrivate &dd, Node *parent=nullptr)
	Constructor for inner use.
virtual bool	CanActivate () const
	Returns true if the process can be activated.
Protected Member Functions inherited from VSN::Process
	Process (Viewport *pViewport, Node *pParent=nullptr)
	Default constructor.
	Process (ProcessPrivate &dd, Node *parent=nullptr)
	NO TRANSLATION.
Protected Member Functions inherited from VSN::Essence
	Essence (EssencePrivate &dd, Node *parent=nullptr)
	Constructor setting parent node and private data.
Protected Member Functions inherited from VSN::Node
	Node (NodePrivate &dd, Node *pParent)
	Sets the node enable flag. More...
virtual void	SceneModificationEvent (const std::shared_ptr< SceneModification > &modification)
	The function is called in case of scene being modified.

Detailed Description

PrCameraZoom class provides scene zooming about its center.

NO TRANSLATION.

Member Function Documentation

SetZoomLimit()

void VSN::PrCameraZoom::SetZoomLimit

(

float

zoomlimit

)

Set the maximum zoom value for a camera. It guarantees that the window always views more than this number of units.

Parameters

[in]

zoomlimit

- Pass a value in object space units.

---

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

• vsn_prcamerazoom.h