|
| 1 | +--- |
| 2 | +title: Component |
| 3 | +categories: Behavioral |
| 4 | +language: en |
| 5 | +tags: |
| 6 | +- Game programming |
| 7 | +- Domain |
| 8 | +--- |
| 9 | + |
| 10 | +## Intent |
| 11 | + |
| 12 | +The component design pattern enables developers to decouple attributes of an objects. Essentially allowing a single |
| 13 | +component to be inheritable by multiple domains/objects without linking the objects to each other. In addition to this |
| 14 | +benefit, the component design pattern allows developer to write maintainable and comprehensible code which is less |
| 15 | +likely to result in monolithic classes. |
| 16 | + |
| 17 | + |
| 18 | + |
| 19 | +## Explanation |
| 20 | + |
| 21 | +Real world example |
| 22 | +> Suppose your video game consists of a graphics component and a sound component. Including the methods and attributes of both of these features in a single java class can be problematic due to many reasons. Firstly, the graphics and sound code can create an extremely long java class which can be hard to maintain. Furthermore, graphics components may be written and implemented by a separate team as to the sound contents. If both parties work simultaneously on the same java class, this may cause conflicts and major delay. Using the component design pattern, the development team is able to create individual component classes for graphics and sound whilst providing the domain/object the reach to both of these attributes. |
| 23 | +
|
| 24 | + |
| 25 | +In plain words |
| 26 | +> The component design pattern provides a single attribute to be accessible by numerous objects without requiring the |
| 27 | +> existence of a relationship between the objects themselves. |
| 28 | +
|
| 29 | +Key drawback |
| 30 | +> With the implementation of the component design pattern, it can be very difficult to create a relationship |
| 31 | +> between components. For example, suppose we require the sound component to be aware of the current animation in order |
| 32 | +> create a certain sound based upon the animation; this can be quite tricky as the component design pattern makes |
| 33 | +> components 'unaware' of other components' existence due to its decoupling nature. |
| 34 | +
|
| 35 | +**Programmatic Example** |
| 36 | + |
| 37 | +The App class creates a demonstration of the use of the component pattern by creating two different objects which |
| 38 | +inherit a small collection of individual components that are modifiable. |
| 39 | + |
| 40 | +```java |
| 41 | +public final class App { |
| 42 | + /** |
| 43 | + * Program entry point. |
| 44 | + * |
| 45 | + * @param args args command line args. |
| 46 | + */ |
| 47 | + public static void main(String[] args) { |
| 48 | + final var player = GameObject.createPlayer(); |
| 49 | + final var npc = GameObject.createNpc(); |
| 50 | + |
| 51 | + |
| 52 | + LOGGER.info("Player Update:"); |
| 53 | + player.update(KeyEvent.KEY_LOCATION_LEFT); |
| 54 | + LOGGER.info("NPC Update:"); |
| 55 | + npc.demoUpdate(); |
| 56 | + } |
| 57 | +} |
| 58 | +``` |
| 59 | + |
| 60 | +Much of the program exists within the GameObject class, within this class, the player and NPC object create methods are |
| 61 | +set up. Additionally, this class also consists of the method calls used to update/alter information of the object's |
| 62 | +components. |
| 63 | + |
| 64 | +```java |
| 65 | +public class GameObject { |
| 66 | + private final InputComponent inputComponent; |
| 67 | + private final PhysicComponent physicComponent; |
| 68 | + private final GraphicComponent graphicComponent; |
| 69 | + |
| 70 | + public String name; |
| 71 | + public int velocity = 0; |
| 72 | + public int coordinate = 0; |
| 73 | + |
| 74 | + public static GameObject createPlayer() { |
| 75 | + return new GameObject(new PlayerInputComponent(), |
| 76 | + new ObjectPhysicComponent(), |
| 77 | + new ObjectGraphicComponent(), |
| 78 | + "player"); |
| 79 | + } |
| 80 | + |
| 81 | + public static GameObject createNpc() { |
| 82 | + return new GameObject( |
| 83 | + new DemoInputComponent(), |
| 84 | + new ObjectPhysicComponent(), |
| 85 | + new ObjectGraphicComponent(), |
| 86 | + "npc"); |
| 87 | + } |
| 88 | + |
| 89 | + public void demoUpdate() { |
| 90 | + inputComponent.update(this); |
| 91 | + physicComponent.update(this); |
| 92 | + graphicComponent.update(this); |
| 93 | + } |
| 94 | + |
| 95 | + public void update(int e) { |
| 96 | + inputComponent.update(this, e); |
| 97 | + physicComponent.update(this); |
| 98 | + graphicComponent.update(this); |
| 99 | + } |
| 100 | + |
| 101 | + public void updateVelocity(int acceleration) { |
| 102 | + this.velocity += acceleration; |
| 103 | + } |
| 104 | + |
| 105 | + public void updateCoordinate() { |
| 106 | + this.coordinate += this.velocity; |
| 107 | + } |
| 108 | +} |
| 109 | +``` |
| 110 | + |
| 111 | +Upon opening the component package, the collection of components are revealed. These components provide the interface |
| 112 | +for objects to inherit these domains. The PlayerInputComponent class shown below updates the object's velocity |
| 113 | +characteristic based on user's key event input. |
| 114 | + |
| 115 | +```java |
| 116 | +public class PlayerInputComponent implements InputComponent { |
| 117 | + private static final int walkAcceleration = 1; |
| 118 | + |
| 119 | + /** |
| 120 | + * The update method to change the velocity based on the input key event. |
| 121 | + * |
| 122 | + * @param gameObject the gameObject instance |
| 123 | + * @param e key event instance |
| 124 | + */ |
| 125 | + @Override |
| 126 | + public void update(GameObject gameObject, int e) { |
| 127 | + switch (e) { |
| 128 | + case KeyEvent.KEY_LOCATION_LEFT -> { |
| 129 | + gameObject.updateVelocity(-WALK_ACCELERATION); |
| 130 | + LOGGER.info(gameObject.getName() + " has moved left."); |
| 131 | + } |
| 132 | + case KeyEvent.KEY_LOCATION_RIGHT -> { |
| 133 | + gameObject.updateVelocity(WALK_ACCELERATION); |
| 134 | + LOGGER.info(gameObject.getName() + " has moved right."); |
| 135 | + } |
| 136 | + default -> { |
| 137 | + LOGGER.info(gameObject.getName() + "'s velocity is unchanged due to the invalid input"); |
| 138 | + gameObject.updateVelocity(0); |
| 139 | + } // incorrect input |
| 140 | + } |
| 141 | + } |
| 142 | +} |
| 143 | +``` |
| 144 | + |
| 145 | +## Class diagram |
| 146 | + |
| 147 | + |
| 148 | + |
| 149 | +## Applicability |
| 150 | + |
| 151 | +Use the component design pattern when |
| 152 | + |
| 153 | +- you have a class which access multiple features which you would like to keep separate. |
| 154 | +- you want to reduce the length of a class. |
| 155 | +- you require a variety of objects to share a collection of components but the use of inheritance isn't specific enough. |
| 156 | + |
| 157 | +## Credits |
| 158 | + |
| 159 | +- [Component Design Pattern] (https://gameprogrammingpatterns.com/component.html) |
| 160 | +- [Component pattern - game programming series - Tutemic] (https://www.youtube.com/watch?v=n92GBp2WMkg&ab_channel=Tutemic) |
0 commit comments