U4DEngine::U4DButton Class Reference
The U4DButton class manages button entities. More...
Inherits U4DEngine::U4DShaderEntity.
Public Member Functions | |
| U4DButton (std::string uName, float xPosition, float yPosition, float uWidth, float uHeight, std::string uLabel, std::string uFontData) | |
| Constructor for the class. More... | |
| U4DButton (std::string uName, float xPosition, float yPosition, float uWidth, float uHeight, const char *uButtonImage) | |
| ~U4DButton () | |
| Destructor for the class. More... | |
| void | update (double dt) |
| Calls the state manager to update the state of the button. More... | |
| void | action () |
| Informs the callback pointer to call the appropriate method. More... | |
| bool | changeState (INPUTELEMENTACTION uInputAction, U4DVector2n uPosition) |
| Changes the state of the button depending on the touch position. More... | |
| bool | getIsPressed () |
| Returns true if the button is pressed. | |
| bool | getIsReleased () |
| Returns true if button is released. | |
| void | setCallbackAction (U4DCallbackInterface *uAction) |
| Initializes the callback interface. More... | |
| void | changeState (int uState) |
| int | getState () |
| void | setState (int uState) |
 Public Member Functions inherited from U4DEngine::U4DShaderEntity | |
| U4DShaderEntity (int uParamSize) | |
| void | setShaderDimension (float uWidth, float uHeight) |
| void | setTexture0 (const char *uTexture0) |
| void | setTexture1 (const char *uTexture1) |
| void | render (id< MTLRenderCommandEncoder > uRenderEncoder) |
| void | updateShaderParameterContainer (int uPosition, U4DVector4n &uParamater) |
| std::vector< U4DVector4n > | getShaderParameterContainer () |
| void | setEnableBlending (bool uValue) |
| bool | getEnableBlending () |
| float | getShaderWidth () |
| float | getShaderHeight () |
| void | setEnableAdditiveRendering (bool uValue) |
| sets whether additive rendering should be enabled. More... | |
| bool | getEnableAdditiveRendering () |
| gets whether additive rendering was enabled More... | |
| void | setHasTexture (bool uValue) |
| bool | getHasTexture () |
| Public Member Functions inherited from U4DEngine::U4DVisibleEntity | |
| U4DVisibleEntity () | |
| Constructor for the class. | |
| virtual | ~U4DVisibleEntity () |
| Destructor for the class. | |
| U4DVisibleEntity (const U4DVisibleEntity &value) | |
| Copy constructor for the visible entity. | |
| U4DVisibleEntity & | operator= (const U4DVisibleEntity &value) |
| Copy constructor for the visible entity. More... | |
| virtual void | updateAllUniforms () |
| void | loadRenderingInformation () |
| Method which loads all rendering information for the entiy. | |
| std::string | getFragmentShader () |
| get the name of the fragment shader More... | |
| U4DRenderEntity * | getRenderEntity () |
| void | setPipelineForPass (std::string uPipelineName, int uRenderPassKey) |
| void | setPipeline (std::string uPipelineName) |
| sets the pipeline for the default final pass More... | |
| Public Member Functions inherited from U4DEngine::U4DEntity | |
| U4DEntity () | |
| Entity Constructor. It creates the entity with the local orientation set to zero and local position set to the origin. The forwad vector is set to (0.0,0.0,-1.0). Parent and Next pointer set to null. | |
| ~U4DEntity () | |
| Entity Destructor. | |
| U4DEntity (const U4DEntity &value) | |
| Entity Copy Constructor. | |
| U4DEntity & | operator= (const U4DEntity &value) |
| Entity Copy Constructor. More... | |
| void | setName (std::string uName) |
| Method which sets the name of the Entity. More... | |
| std::string | getName () |
| Method which returns the name of the Entity. More... | |
| void | setEntityType (ENTITYTYPE uType) |
| Method which sets the type of the Entity. More... | |
| ENTITYTYPE | getEntityType () |
| Method which returns the type of the Entity. More... | |
| void | setLocalSpace (U4DDualQuaternion &uLocalSpace) |
| Method which sets the local space of the Entity. More... | |
| void | setLocalSpace (U4DMatrix4n &uMatrix) |
| Method which sets the local space of the Entity. More... | |
| U4DDualQuaternion | getLocalSpace () |
| U4DDualQuaternion | getAbsoluteSpace () |
| Method which returns the absolute space of the Entity. More... | |
| U4DQuaternion | getLocalSpaceOrientation () |
| Method which returns the local orientation space of the Entity. More... | |
| U4DQuaternion | getLocalSpacePosition () |
| Method which returns the local position space of the Entity. More... | |
| U4DQuaternion | getAbsoluteSpaceOrientation () |
| Method which returns the absolute orientation space of the Entity. More... | |
| U4DQuaternion | getAbsoluteSpacePosition () |
| Method which returns the absolute position space of the Entity. More... | |
| void | setLocalSpaceOrientation (U4DQuaternion &uOrientation) |
| Method which sets the local space orientation of the Entity. More... | |
| void | setLocalSpacePosition (U4DQuaternion &uPosition) |
| Method which sets the local space position of the Entity. More... | |
| U4DVector3n | getLocalOrientation () |
| Method which returns the Local orientation of the Entity. More... | |
| U4DVector3n | getLocalPosition () |
| Method which returns the local position of the Entity. More... | |
| U4DVector3n | getAbsoluteOrientation () |
| Method which returns the absolute orientation of the Entity. More... | |
| U4DVector3n | getAbsolutePosition () |
| Method which returns the absolute position of the Entity. More... | |
| U4DVector3n | getEntityForwardVector () |
| Method which returns the forwad vector of the Entity. More... | |
| void | setEntityForwardVector (U4DVector3n &uForwardVector) |
| Method which sets the forward vectof of the Entity. The default value is (0.0,0.0,-1.0) More... | |
| U4DMatrix3n | getAbsoluteMatrixOrientation () |
| Method which returns the absolute orientation of the Entity. More... | |
| U4DMatrix3n | getLocalMatrixOrientation () |
| Method which returns the local orientation of the Entity. More... | |
| void | translateTo (U4DVector3n &translation) |
| Method which translates entity to a new position. More... | |
| void | translateTo (float x, float y, float z) |
| Method which translates entity to a new position. More... | |
| void | translateTo (U4DVector2n &translation) |
| Method which translates entity to a new position. More... | |
| void | translateBy (float x, float y, float z) |
| Method which translates entity by certain amount. More... | |
| void | translateBy (U4DVector3n &translation) |
| Method which translates entity by a certain amount. More... | |
| void | rotateTo (U4DQuaternion &rotation) |
| Method which rotates entity to a new orientation. More... | |
| void | rotateBy (U4DQuaternion &rotation) |
| Method which rotates entity by a certain amount. More... | |
| void | rotateTo (float angle, U4DVector3n &axis) |
| Method which rotates entity to a new orientation. More... | |
| void | rotateBy (float angle, U4DVector3n &axis) |
| Method which rotates entity by certain amount. More... | |
| void | rotateTo (float angleX, float angleY, float angleZ) |
| Method which rotates entity to a new orientation. More... | |
| void | rotateBy (float angleX, float angleY, float angleZ) |
| Method which rotates entity by a certain amount. More... | |
| void | rotateAboutAxis (float angle, U4DVector3n &axisOrientation, U4DVector3n &axisPosition) |
| Method which rotates entity about an axis. More... | |
| void | rotateAboutAxis (U4DQuaternion &uOrientation, U4DVector3n &axisPosition) |
| Method which rotates entity about an axis. More... | |
| virtual void | viewInDirection (U4DVector3n &uDestinationPoint) |
| Method which sets the view direction of the entity. More... | |
| virtual U4DVector3n | getViewInDirection () |
| Method which rotates the view direction of the entiy. More... | |
| void | setZDepth (int uZDepth) |
| Loads all rendering information for the entiy / virtual void loadRenderingInformation(){};. More... | |
| int | getZDepth () |
| Gets the z-depth value used for rendering ordering. More... | |
| Public Member Functions inherited from U4DEngine::U4DEntityNode< U4DEntity > | |
| U4DEntityNode () | |
| Constructor for the class. | |
| U4DEntityNode (std::string uNodeName) | |
| ~U4DEntityNode () | |
| Destructor for the class. | |
| void | addChild (U4DEntity *uChild) |
| Method which adds a child node to a scenegraph. More... | |
| void | addChild (U4DEntity *uChild, U4DEntity *uNext) |
| void | addChild (U4DEntity *uChild, int uZDepth) |
| Method which adds a child entity to a scenegraph at a particular location. More... | |
| void | removeChild (U4DEntity *uChild) |
| Method which removes a child node from the scenegraph. More... | |
| void | changeLastDescendant (U4DEntity *uNewLastDescendant) |
| Method which changes the node's last descendant in the scenegraph. More... | |
| U4DEntity * | getFirstChild () |
| Method which returns the node's first child in the scenegraph. More... | |
| U4DEntity * | getLastChild () |
| Method which returns the node's last child in the scenegraph. More... | |
| U4DEntity * | getNextSibling () |
| Method which returns the node's next sibling in the scenegraph. More... | |
| U4DEntity * | getPrevSibling () |
| Method which returns the node's previous sibling in the scenegraph. More... | |
| U4DEntity * | prevInPreOrderTraversal () |
| Method which returns the node's previous sibling in pre-order traversal order. More... | |
| U4DEntity * | nextInPreOrderTraversal () |
| Method which returns the node's next pointer in pre-order traversal order. More... | |
| bool | isLeaf () |
| Method which returns true if the node represents a leaf node in the scenegraph. More... | |
| bool | isRoot () |
| Method which returns true if the node represents a root node in the scenegraph. More... | |
| U4DEntity * | getParent () |
| Gets the parent to the entity. More... | |
| U4DEntity * | getRootParent () |
| Gets the root parent (top parent in the scenegraph) of the entity. More... | |
| U4DEntity * | searchChild (std::string uName) |
Public Attributes | |
| U4DCallbackInterface * | pCallback |
| Pointer to the callback object. More... | |
| U4DControllerInterface * | controllerInterface |
| Pointer to the controller interface. More... | |
| Public Attributes inherited from U4DEngine::U4DShaderEntity | |
| U4DVertexData | bodyCoordinates |
| Object which contains attribute data such as vertices, and uv-coordinates. | |
| U4DTextureData | textureInformation |
| Object which contains texture information. | |
| Public Attributes inherited from U4DEngine::U4DVisibleEntity | |
| U4DRenderEntity * | renderEntity |
| pointer to the rendering entity | |
| Public Attributes inherited from U4DEngine::U4DEntity | |
| U4DDualQuaternion | localSpace |
| Local Space of the entity. | |
| U4DDualQuaternion | absoluteSpace |
| Absolute Space of the entity. | |
| U4DTransformation * | transformation |
| U4DTransformation object pointer in charge of translating/rotating the entity. | |
| U4DVector3n | entityForwardVector |
| Forward vector of the entity. This is used to compute the view-direction vector. | |
| int | zDepth |
| z-depth used for rendering ordering | |
| Public Attributes inherited from U4DEngine::U4DEntityNode< U4DEntity > | |
| U4DEntity * | parent |
| Tree parent pointer. | |
| U4DEntity * | prevSibling |
| Tree previous sibling pointer. | |
| U4DEntity * | next |
| Tree next pointer. | |
| U4DEntity * | lastDescendant |
| Tree last descendant pointer. | |
Additional Inherited Members | |
| Protected Attributes inherited from U4DEngine::U4DEntity | |
| U4DVector3n | localOrientation |
| Entity local orientation. | |
| U4DVector3n | localPosition |
| Entity local position. | |
| U4DVector3n | absoluteOrientation |
| Entity absolute orientation. | |
| U4DVector3n | absolutePosition |
| Entity absolute position. | |
Detailed Description
The U4DButton class manages button entities.
Constructor & Destructor Documentation
◆ U4DButton()
| U4DEngine::U4DButton::U4DButton | ( | std::string | uName, |
| float | xPosition, | ||
| float | yPosition, | ||
| float | uWidth, | ||
| float | uHeight, | ||
| std::string | uLabel, | ||
| std::string | uFontData | ||
| ) |
Constructor for the class.
It creates a button object at the position and with the dimension and images specified. It also creates a state manager
- Parameters
-
uName Name of the button xPosition x-axis position yPosition y-axis position uWidth width of button uHeight height of button
◆ ~U4DButton()
| U4DEngine::U4DButton::~U4DButton | ( | ) |
Destructor for the class.
deletes the state manager
Member Function Documentation
◆ action()
| void U4DEngine::U4DButton::action | ( | ) |
Informs the callback pointer to call the appropriate method.
The method the callback pointer calls is set up during the initialization of the controller. This is set up by the user.
◆ changeState()
|
virtual |
Changes the state of the button depending on the touch position.
It checks if the user input touch coordinates falls within the location of the buttons
- Parameters
-
uInputAction touch state such as began, ended, released uPosition position of touch
Reimplemented from U4DEngine::U4DEntity.
◆ setCallbackAction()
| void U4DEngine::U4DButton::setCallbackAction | ( | U4DCallbackInterface * | uAction | ) |
Initializes the callback interface.
The callback is set during the controller initialization by the user. It sets which method to call if there is an action detected on the button
- Parameters
-
uAction callback interface object
◆ update()
|
virtual |
Calls the state manager to update the state of the button.
The state manager updates the state of the button depending on the current touch position
- Parameters
-
dt game tick
Reimplemented from U4DEngine::U4DShaderEntity.
Member Data Documentation
◆ controllerInterface
| U4DControllerInterface* U4DEngine::U4DButton::controllerInterface |
Pointer to the controller interface.
Usually the controller interface for button is the touch interface
◆ pCallback
| U4DCallbackInterface* U4DEngine::U4DButton::pCallback |
Pointer to the callback object.
This callback is used to inform the button which method to call upon pressed
