Drag[en]gine Script Module DragonScript  1.23
Dragengine.Commands.BindingInputProcessor Class Reference

Run command matching binding from binding manager. More...

Inheritance diagram for Dragengine.Commands.BindingInputProcessor:
Dragengine.Utils.DefaultInputProcessor Dragengine.Utils.InputProcessor

Public Member Functions

BindingManager getBindingManager ()
 Binding manager. More...
 
float getMouseSensitivity ()
 Mouse sensitivity. More...
 
float getScaleMouseAxis ()
 Mouse axis scaling factor. More...
 
float getScaleMouseWheel ()
 Mouse wheel scaling factor. More...
 
void inputEvent (InputEvent event)
 Process input event. More...
 
BindingInputProcessor new (BindingManager bindingManager)
 Create input processor. More...
 
void setScaleMouseAxis (float scale)
 Set mouse axis scaling factor. More...
 
void setScaleMouseWheel (float scale)
 Set mouse wheel scaling factor. More...
 
- Public Member Functions inherited from Dragengine.Utils.DefaultInputProcessor
DefaultInputProcessor new ()
 Create input processor. More...
 

Protected Member Functions

void activate (Binding binding)
 Activate binding command. More...
 
void analogAbsolute (Binding binding, float value)
 Absolute analog input to binding command. More...
 
void analogRelative (Binding binding, float value)
 Relative analog input to binding command. More...
 
void deactivate (Binding binding)
 Deactivate binding command. More...
 
void touch (Binding binding)
 Touch binding command. More...
 
void untouch (Binding binding)
 Untouch binding command. More...
 

Detailed Description

Run command matching binding from binding manager.

The binding input processor supports scaling the mouse axis and mouse wheel movement. This is a game play specific scaling value between the mouse movement and the input value passed on to the bindings. This is not the same as mouse sensitivity. The binding supports mouse sensitivity using BaseGameApp.settingInputMouseSensitivity setting.

Member Function Documentation

◆ activate()

void Dragengine.Commands.BindingInputProcessor.activate ( Binding  binding)
protected

Activate binding command.

Default implementation calls Command.start() .

◆ analogAbsolute()

void Dragengine.Commands.BindingInputProcessor.analogAbsolute ( Binding  binding,
float  value 
)
protected

Absolute analog input to binding command.

Default implementation calls Command.analogRelative() .

◆ analogRelative()

void Dragengine.Commands.BindingInputProcessor.analogRelative ( Binding  binding,
float  value 
)
protected

Relative analog input to binding command.

Default implementation calls Command.analogRelative() .

◆ deactivate()

void Dragengine.Commands.BindingInputProcessor.deactivate ( Binding  binding)
protected

Deactivate binding command.

Default implementation calls Command.stop() .

◆ getBindingManager()

BindingManager Dragengine.Commands.BindingInputProcessor.getBindingManager ( )

Binding manager.

◆ getMouseSensitivity()

float Dragengine.Commands.BindingInputProcessor.getMouseSensitivity ( )

Mouse sensitivity.

Version
1.18

If BaseGameApp exists returns BaseGameApp.getApp().getMouseSensitivity() otherwise 1. If you do not use BaseGameApp overwrite this method to return the appropriate value.

◆ getScaleMouseAxis()

float Dragengine.Commands.BindingInputProcessor.getScaleMouseAxis ( )

Mouse axis scaling factor.

◆ getScaleMouseWheel()

float Dragengine.Commands.BindingInputProcessor.getScaleMouseWheel ( )

Mouse wheel scaling factor.

◆ inputEvent()

void Dragengine.Commands.BindingInputProcessor.inputEvent ( InputEvent  event)

Process input event.

Reimplemented from Dragengine.Utils.DefaultInputProcessor.

◆ new()

BindingInputProcessor Dragengine.Commands.BindingInputProcessor.new ( BindingManager  bindingManager)

Create input processor.

◆ setScaleMouseAxis()

void Dragengine.Commands.BindingInputProcessor.setScaleMouseAxis ( float  scale)

Set mouse axis scaling factor.

Default value is 0.2

◆ setScaleMouseWheel()

void Dragengine.Commands.BindingInputProcessor.setScaleMouseWheel ( float  scale)

Set mouse wheel scaling factor.

Default value is 0.2

◆ touch()

void Dragengine.Commands.BindingInputProcessor.touch ( Binding  binding)
protected

Touch binding command.

Default implementation calls Command.touch() .

◆ untouch()

void Dragengine.Commands.BindingInputProcessor.untouch ( Binding  binding)
protected

Untouch binding command.

Default implementation calls Command.untouch() .


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