#include <MouseInputModule.h>

Inheritance diagram for dyno::MouseInputModule:

[legend]

Collaboration diagram for dyno::MouseInputModule:

[legend]

Public Member Functions
	MouseInputModule ()

	~MouseInputModule () override

void	enqueueEvent (PMouseEvent event)

	DEF_VAR (bool, CacheEvent, false, "If set false, all previous queued events will be dropped")

Public Member Functions inherited from dyno::InputModule
	InputModule ()

virtual	~InputModule ()

std::string	getModuleType () final

Public Member Functions inherited from dyno::Module
	Module (std::string name="default")

	~Module (void) override

bool	initialize ()

void	update ()

void	setName (std::string name)

std::string	getName () override

virtual void	setParentNode (Node *node)
	Set the parent node.

Node *	getParentNode ()

SceneGraph *	getSceneGraph ()

bool	isInitialized ()

bool	attachField (FBase *field, std::string name, std::string desc, bool autoDestroy=true) override
	Attach a field to Base.

bool	isInputComplete ()
	Check the completeness of input fields.

bool	isOutputCompete ()

	DEF_VAR (bool, ForceUpdate, false, "")

void	setUpdateAlways (bool b)
	Set the update strategy for the module.

Public Member Functions inherited from dyno::OBase
	OBase ()

	~OBase () override

virtual std::string	caption ()
	Return the caption.

virtual bool	captionVisible ()
	Whether to hide the caption in the GUI.

virtual std::string	description ()
	Return a description for the node or module, override this function to support user-defined description.

bool	addField (FBase *data)
	Add a field to Base FieldID will be set to the name of Field by default.

bool	addField (FieldID name, FBase *data)
	Add a field to Base.

bool	addFieldAlias (FieldID name, FBase *data)

bool	addFieldAlias (FieldID name, FBase *data, FieldMap &fieldAlias)

bool	findField (FBase *data)
	Find a field by its pointer.

bool	findFieldAlias (const FieldID name)
	Find a field by its name.

bool	findFieldAlias (const FieldID name, FieldMap &fieldAlias)
	Find a field in fieldAlias by its name This function is typically called by other functions.

bool	removeField (FBase *data)
	Remove a field by its pointer.

bool	removeFieldAlias (const FieldID name)
	Remove a field by its name.

bool	removeFieldAlias (const FieldID name, FieldMap &fieldAlias)

FBase *	getField (const FieldID name)
	Return a field by its name.

std::vector< FBase * > &	getAllFields ()

template<typename T>
T *	getField (FieldID name)

bool	isAllFieldsReady ()
	Check the completeness of all required fields.

std::vector< FieldID >	getFieldAlias (FBase *data)

int	getFieldAliasCount (FBase *data)

void	setBlockCoord (float x, float y)

float	bx ()

float	by ()

bool	findInputField (FBase *field)

bool	addInputField (FBase *field)

bool	removeInputField (FBase *field)

std::vector< FBase * > &	getInputFields ()

bool	findOutputField (FBase *field)

bool	addOutputField (FBase *field)

bool	addToOutput (FBase *field)

bool	removeOutputField (FBase *field)

bool	removeFromOutput (FBase *field)

std::vector< FBase * > &	getOutputFields ()

bool	findParameter (FBase *field)

bool	addParameter (FBase *field)

bool	removeParameter (FBase *field)

std::vector< FBase * > &	getParameters ()

Public Member Functions inherited from dyno::Object
	Object ()

virtual	~Object ()

ObjectId	objectId ()

Protected Member Functions
virtual void	onEvent (PMouseEvent event)

void	updateImpl () final

bool	requireUpdate () override

Protected Member Functions inherited from dyno::Module
virtual bool	initializeImpl ()

virtual void	preprocess ()

virtual void	postprocess ()

virtual bool	validateInputs ()

virtual bool	validateOutputs ()

virtual void	updateStarted ()
	Two functions called at the beginning and end of update() used for debug.

virtual void	updateEnded ()

Private Attributes
std::deque< PMouseEvent >	mEventQueue

std::mutex	mMutex

Additional Inherited Members
Public Types inherited from dyno::OBase
typedef std::vector< FBase * >	FieldVector

typedef std::map< FieldID, FBase * >	FieldMap

Static Public Member Functions inherited from dyno::Object
static bool	registerClass (ClassInfo *ci)

static Object *	createObject (std::string name)

static std::map< std::string, ClassInfo * > *	getClassMap ()

static ObjectId	baseId ()
	Base Id.

Protected Attributes inherited from dyno::OBase
std::vector< FBase * >	fields_input

std::vector< FBase * >	fields_output

std::vector< FBase * >	fields_param

Detailed Description

Definition at line 24 of file MouseInputModule.h.

Constructor & Destructor Documentation

◆ MouseInputModule()

dyno::MouseInputModule::MouseInputModule ( )

Definition at line 5 of file MouseInputModule.cpp.

Here is the call graph for this function:

◆ ~MouseInputModule()

dyno::MouseInputModule::~MouseInputModule ( )

override

Definition at line 11 of file MouseInputModule.cpp.

Member Function Documentation

◆ DEF_VAR()

dyno::MouseInputModule::DEF_VAR	(	bool	,
		CacheEvent	,
		false	,
		"If set	false,
		all previous queued events will be dropped"	)

◆ enqueueEvent()

void dyno::MouseInputModule::enqueueEvent ( PMouseEvent event )

Definition at line 15 of file MouseInputModule.cpp.

◆ onEvent()

virtual void dyno::MouseInputModule::onEvent ( PMouseEvent event )

inlineprotectedvirtual

Reimplemented in dyno::DragSurfaceInteraction< TDataType >, dyno::DragVertexInteraction< TDataType >, dyno::EdgeInteraction< TDataType >, dyno::PointInteraction< TDataType >, and dyno::SurfaceInteraction< TDataType >.

Definition at line 35 of file MouseInputModule.h.

Here is the caller graph for this function:

◆ requireUpdate()

bool dyno::MouseInputModule::requireUpdate ( )

overrideprotectedvirtual

Reimplemented from dyno::Module.

Definition at line 52 of file MouseInputModule.cpp.

Here is the call graph for this function:

◆ updateImpl()

void dyno::MouseInputModule::updateImpl ( )

finalprotectedvirtual

Reimplemented from dyno::Module.

Definition at line 40 of file MouseInputModule.cpp.

Here is the call graph for this function:

Member Data Documentation

◆ mEventQueue

std::deque<PMouseEvent> dyno::MouseInputModule::mEventQueue

private

Definition at line 42 of file MouseInputModule.h.

◆ mMutex

std::mutex dyno::MouseInputModule::mMutex

private

Definition at line 44 of file MouseInputModule.h.

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

D:/Peridyno/peridyno/src/Framework/Module/MouseInputModule.h
D:/Peridyno/peridyno/src/Framework/Module/MouseInputModule.cpp

Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ MouseInputModule()

◆ ~MouseInputModule()

Member Function Documentation

◆ DEF_VAR()

◆ enqueueEvent()

◆ onEvent()

◆ requireUpdate()

◆ updateImpl()

Member Data Documentation

◆ mEventQueue

◆ mMutex