PrFindSelectObject class performs searching objects with the bounding frame. More...

#include <vsn_prfindselectobject.h>

Inheritance diagram for VSN::PrFindSelectArea:

Collaboration diagram for VSN::PrFindSelectArea:

Public Types
enum	RectType { }
	All possible types of object selection behavior. More...

Public Member Functions
	PrFindSelectArea (GraphicsScene pGraphicsScene, Node parent=nullptr)
	Constructor for inner use.

virtual	~PrFindSelectArea ()
	Destructor.

Color	GetUnifyingRectFillColor () const
	Returns the filling color of the unifying frame.

Color	GetUnifyingRectBorderColor () const
	Returns the border color of the unifying frame.

void	SetUnifyingColorRect (const Color &clrFill, const Color &clrBorder)
	Sets the border and filling color of the unifying frame.

Color	GetCuttingRectFillColor () const
	Returns the filling color of the cutting frame.

Color	GetCuttingColorRectBorderColor () const
	Returns the border color of the cutting frame.

void	SetCuttingColorRect (const Color &clrFill, const Color &clrBorder)
	Sets the border and filling color of the cutting frame.

bool	IsObjectUnderCursor () const
	Checks if there is an object under the mouse cursor.

int	GetStartDragDistance () const
	Returns the drag distance to start drawing the frame.

void	SetStartDragDistance (int dis)
	Sets the drag distance to start drawing the frame.

Public Member Functions inherited from VSN::PrBasicFindSelect
virtual	~PrBasicFindSelect ()
	Destructor.

virtual void	SetPickSelection (ObjectPickSelection *pPickSelection)
	Sets a pointer to the object search.

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
virtual bool	CanActivate () const
	The slot is to activate and initialize the given process. More...

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

PrFindSelectObject class performs searching objects with the bounding frame.

PrFindSelectArea class, like PrFindSelectObject class, can be added on the user's own in the ObjectPickSelection class search mechanism. PrFindSelectArea class has a secondary functional that can provide a behavior of the object selection with the frame. The class also has a functional that the user can use to set hotkeys to activate a process. PrFindSelectArea class provides setting a frame color depending on the user interface style.

Member Enumeration Documentation

◆ RectType

enum VSN::PrFindSelectArea::RectType

All possible types of object selection behavior.

Enumerator
at_CuttingUnifying	The frame becomes unifying and cutting, and defines a vector of its direction.
at_OnlyUnifying	The frame becomes cutting and unifying, and defines a vector of its direction.
at_OnlyCutting	The frame becomes only unifying, and makes objects selected when they get in the frame area entirely.

Member Function Documentation

◆ CanActivate()

virtual bool VSN::PrFindSelectArea::CanActivate ( ) const

protectedvirtual

The slot is to activate and initialize the given process.

The slot takes events from the manipulator mouse. Returns true if the process can be activated.

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

vsn_prfindselectobject.h

Public Types

Public Member Functions

Protected Member Functions

Detailed Description

Member Enumeration Documentation

◆ RectType

Member Function Documentation

◆ CanActivate()