Input device component. More...
Public Member Functions | |
Management | |
| InputDevice | getInputDevice () |
| Owner input device. | |
| int | getComponentIndex () |
| Component index. | |
Components | |
| String | getID () |
| Component identifier. | |
| String | getName () |
| Display name. | |
| InputDeviceComponentType | getType () |
| Component type. | |
| Image | getDisplayImage () |
| Image to represent the component in 2D user interfaces or NULL if not set. | |
| int | getDisplayIconCount () |
| Count of icons representing the component in bindings. | |
| Image | getDisplayIconAt (int index) |
| Icon at index representing the component in bindings. | |
| Image | getLargestDisplayIconX (int maxWidth) |
| Largest icon not exceeding width representing the device in bindings. | |
| Image | getLargestDisplayIconY (int maxHeight) |
| Largest icon not exceeding height representing the device in bindings. | |
| String | getDisplayText () |
| Text to display centered across display image or icon. | |
Detailed Description
Input device component.
Wraps a input device component by component index.
Components group buttons, axes and feedbacks into a single unit. For example a joystick on a gamepad typically composes of 2 axes and optionally buttons (for example press down) and feedbacks (rumbling). Using components enables the user to relate these input features.
This is a native class.
Member Function Documentation
◆ getComponentIndex()
| int Dragengine.InputDeviceComponent.getComponentIndex | ( | ) |
Component index.
◆ getDisplayIconAt()
| Image Dragengine.InputDeviceComponent.getDisplayIconAt | ( | int | index | ) |
Icon at index representing the component in bindings.
Icon is of square size and typically has a size of 16, 24, 32 or 64.
◆ getDisplayIconCount()
| int Dragengine.InputDeviceComponent.getDisplayIconCount | ( | ) |
Count of icons representing the component in bindings.
◆ getDisplayImage()
| Image Dragengine.InputDeviceComponent.getDisplayImage | ( | ) |
Image to represent the component in 2D user interfaces or NULL if not set.
Large image of 128 pixels squared or larger.
◆ getDisplayText()
| String Dragengine.InputDeviceComponent.getDisplayText | ( | ) |
Text to display centered across display image or icon.
◆ getID()
| String Dragengine.InputDeviceComponent.getID | ( | ) |
Component identifier.
Unique identifier for the component identifying it inside the parent device. The prefix is a normalized string that contains only letters, numbers and underscores. It is suitable to be combined with the device identifier to store them in config files as key bindings.
◆ getInputDevice()
| InputDevice Dragengine.InputDeviceComponent.getInputDevice | ( | ) |
Owner input device.
◆ getLargestDisplayIconX()
| Image Dragengine.InputDeviceComponent.getLargestDisplayIconX | ( | int | maxWidth | ) |
Largest icon not exceeding width representing the device in bindings.
Icon typically has a size of 16, 24, 32 or 64.
◆ getLargestDisplayIconY()
| Image Dragengine.InputDeviceComponent.getLargestDisplayIconY | ( | int | maxHeight | ) |
Largest icon not exceeding height representing the device in bindings.
Icon typically has a size of 16, 24, 32 or 64.
◆ getName()
| String Dragengine.InputDeviceComponent.getName | ( | ) |
Display name.
Dispaly name is human readable like for example 'Component #1'. The name is unique but not guaranteed to stay the same across restarting the input module or game engine.
◆ getType()
| InputDeviceComponentType Dragengine.InputDeviceComponent.getType | ( | ) |
Component type.
- Version
- 1.6
The documentation for this class was generated from the following file:
