Package paintingcanvas.drawable

Class Square

    • Constructor Summary

      Constructors 
      Constructor Description
      Square​(int centerX, int centerY, int size)
      Create a new Square element.
      Square​(int centerX, int centerY, int size, java.awt.Color color)
      Create a new Square element.
      Square​(int centerX, int centerY, int size, java.lang.String color)
      Create a new Square element with a hue name or hex code

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.awt.Point center​(java.awt.Graphics2D g)
      Get the object's centerpoint
      int getSize()
      Gets the size / side length of the square.
      Square getThis()  
      Square setSize​(int s)
      Sets the size / side length of the square.

      • Methods inherited from class paintingcanvas.drawable.DrawableBase.InteractableShape

        Modifier and Type Method Description
        boolean clicked()
        Check if the element has been clicked by the mouse.
        boolean hovered()
        Check if the element is currently being hovered over by the mouse.
        boolean intersects​(java.awt.Point pos)
        Check if the point intersects with the element.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

      • Methods inherited from interface paintingcanvas.animation.Animatable

        Modifier and Type Method Description
        default AnimationBuilder colorTo​(int hex, double duration)
        Change the color of this to the specified color over duration seconds.
        default AnimationBuilder colorTo​(int r, int g, int b, double duration)
        Change the color of this to the specified color over duration seconds.
        default AnimationBuilder colorTo​(int r, int g, int b, int a, double duration)
        Change the color of this to the specified color over duration seconds.
        default AnimationBuilder colorTo​(java.awt.Color color, double duration)
        Change the color of this to the specified color over duration seconds.
        default AnimationBuilder colorTo​(java.lang.String name, double duration)
        Change the color of this to the specified color over duration seconds.
        default AnimationBuilder colorTo​(Hue hue, double duration)
        Change the color of this to the specified color over duration seconds.
        Drawable<?> drawable()
        Get the Drawable element from this Animatable.
        default AnimationBuilder fadeIn​(double duration)
        Fade this in over duration seconds.
        default AnimationBuilder fadeOut​(double duration)
        Fade this out over duration seconds.
        default AnimationBuilder moveBy​(int x, int y, double duration)
        Move this by the specified x and y over duration seconds.
        default AnimationBuilder moveHorizontalBy​(int x, double duration)
        Move this by the specified x horizontally over duration seconds.
        default AnimationBuilder moveTo​(int x, int y, double duration)
        Move this to the specified x and y over duration seconds
        default AnimationBuilder moveVerticalBy​(int y, double duration)
        Move this by the specified y vertically over duration seconds.
        default AnimationBuilder rotateBy​(int angle, double duration)
        Rotate this by angle degrees over duration seconds.
        default AnimationBuilder rotateTo​(int angle, double duration)
        Rotate this to the specified angle degrees over duration seconds.

      • Methods inherited from interface paintingcanvas.drawable.Colorable

        Modifier and Type Method Description
        java.awt.Color getColor()
        Get the current color of an element as a Color
        void internalSetColor​(java.awt.Color color)  
        default T setColor​(int hex)
        Set the color of this to the specified color.
        default T setColor​(int r, int g, int b)
        Set the color of this to the specified color.
        default T setColor​(int r, int g, int b, int a)
        Set the color of this to the specified color See Wikipedia for how this works.
        default T setColor​(java.awt.Color color)
        Set the color of the object with a Color object.
        default T setColor​(java.lang.String name)
        Set the color of the object with a hue name or hex code.
        default T setColor​(Hue hue)
        Set the color of the object with a Hue object.

      • Methods inherited from interface paintingcanvas.drawable.Drawable

        Modifier and Type Method Description
        default AnimationBuilder animate()
        Start animating this object.
        default T bringToFront()
        Brings the object in front of all other objects.
        java.awt.Point center​(java.awt.Graphics2D g)
        Get the object's centerpoint
        default Drawable<?> drawable()
        Get the Drawable element from this Animatable.
        default void erase()
        Erase this object from the canvas.
        int getLayer()
        Gets the current layer of the object.
        T getThis()  
        T hide()
        Hide the Object.
        void internalSetLayer​(int layer)  
        void render​(java.awt.Graphics2D g)
        Actually render the object itself
        default T sendToBack()
        Puts the object behind all other objects.
        default T setLayer​(int layer)
        Puts the object on a specific layer.
        T show()
        Show the Object

      • Methods inherited from interface paintingcanvas.drawable.Outlineable

        Modifier and Type Method Description
        java.awt.Color getOutlineColor()
        Gets the outline color
        java.awt.Stroke getOutlineStroke()
        Gets the outline stroke
        void internalSetFilled​(boolean filled)  
        void internalSetOutlineColor​(java.awt.Color color)  
        void internalSetOutlineStroke​(java.awt.Stroke stroke)  
        default T removeOutline()
        Removes the outline from the shape
        default T setFilled​(boolean filled)
        Set whether this object is filled or not
        default T setOutline​(int thickness)
        Sets the parameters for the outline of the shape, with the color defaulting to black
        default T setOutline​(int thickness, java.awt.Color color)
        Sets the parameters for the outline of the shape
        default T setOutline​(java.awt.Color color)
        Sets the outline color of the shape

      • Methods inherited from interface paintingcanvas.drawable.Positionable

        Modifier and Type Method Description
        java.awt.Point getPos()
        Get the position of the element
        double getRotation()
        Get an elements rotation
        default int getX()
        Get the X-position of the element
        default int getY()
        Get the Y-position of the element.
        double internalGetRotation()  
        void internalSetPos​(int x, int y)  
        void internalSetRotation​(double rotation)  
        default T move​(int x, int y)
        Moves this drawable by the specified x and y.
        default T moveHorizontal​(int x)
        Moves this drawable by the specified x and y.
        default T moveVertical​(int y)
        Moves this drawable by the specified x and y.
        default T rotate​(double rotation)
        Rotate this element by rotation degrees.
        default T setPos​(int x, int y)
        Set the position of the element.
        default T setRotation​(double rotation)
        Set an elements rotation to rotation degrees.
        default T setX​(int x)
        Set the X-position of the object
        default T setY​(int y)
        Set the Y-position of the element

    • Constructor Detail

      • Square

        public Square​(int centerX,
              int centerY,
              int size)
        Create a new Square element. 
        
 // Create a square centered at (100, 100) with a side length of 30px
 Square square = new Square(100, 100, 30);
        Parameters:
        centerX - The X-position of the square
        centerY - The Y-position of the square
        size - The size of the square

      • Square

        public Square​(int centerX,
              int centerY,
              int size,
              java.awt.Color color)
        Create a new Square element. 
        
 // Create a red square centered at (100, 100) with a side length of 30px
 Square square = new Square(100, 100, 30, new Color(255, 0, 0));
        Parameters:
        centerX - The X-position of the square
        centerY - The Y-position of the square
        size - The size of the square
        color - The color of the square

      • Square

        public Square​(int centerX,
              int centerY,
              int size,
              java.lang.String color)
        Create a new Square element with a hue name or hex code
        Parameters:
        centerX - The X-position of the square
        centerY - The Y-position of the square
        size - The size of the square
        color - The name of the color of the square (case-insensitive)
        See Also:
        Misc.stringToColor(String)

    • Method Detail

      • center

        public java.awt.Point center​(java.awt.Graphics2D g)
        Description copied from interface: Drawable
        Get the object's centerpoint 
        
 import java.awt.Point;

 Point p = drawable.getStartpoint();
 int x = p.x;
 int y = p.y;
        Parameters:
        g - Graphics context
        Returns:
        the object's center-point

      • getThis

        public Square getThis()

      • getSize

        public int getSize()
        Gets the size / side length of the square.
        Returns:
        The size of the square in pixels
        See Also:
        setSize(int)

      • setSize

        public Square setSize​(int s)
        Sets the size / side length of the square.
        Parameters:
        s - The new size of the square in pixels
        Returns:
        The original object to allow method chaining
        See Also:
        getSize()