com.hfg.graphics.units.GfxSize2D Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of com_hfg Show documentation
com.hfg xml, html, svg, and bioinformatics utility library
There is a newer version: 20240423
package com.hfg.graphics.units;


//------------------------------------------------------------------------------
/**
 * Container for unit-independent 2D width and height.
 *
 * @author J. Alex Taylor, hairyfatguy.com
 */
//------------------------------------------------------------------------------
// com.hfg XML/HTML Coding Library
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
//
// J. Alex Taylor, President, Founder, CEO, COO, CFO, OOPS hairyfatguy.com
// [email protected]
//------------------------------------------------------------------------------

public class GfxSize2D
{
   private GfxSize mWidth;
   private GfxSize mHeight;


   //##########################################################################
   // CONSTRUCTORS
   //##########################################################################

   //--------------------------------------------------------------------------
   public GfxSize2D()
   {

   }

   //##########################################################################
   // PUBLIC METHODS
   //##########################################################################


   //--------------------------------------------------------------------------
   public GfxSize2D setWidth(GfxSize inValue)
   {
      mWidth = inValue;
      return this;
   }

   //--------------------------------------------------------------------------
   public GfxSize getWidth()
   {
      return mWidth;
   }

   //--------------------------------------------------------------------------
   public GfxSize2D setHeight(GfxSize inValue)
   {
      mHeight = inValue;
      return this;
   }

   //--------------------------------------------------------------------------
   public GfxSize getHeight()
   {
      return mHeight;
   }

   //--------------------------------------------------------------------------
   public void scale(float inScalingFactor)
   {
      getHeight().scale(inScalingFactor);
      getWidth().scale(inScalingFactor);
   }

   //---------------------------------------------------------------------------
   public GfxSize2D applyMaxDimensionsPreservingAspectRatio(GfxSize2D inMaxDimensions)
   {
      float widthPx  = getWidth().to(GfxUnits.pixels);
      float heightPx = getHeight().to(GfxUnits.pixels);

      // Are we exceeding the maximum dimensions?
      float maxWidthPx  = inMaxDimensions.getWidth().to(GfxUnits.pixels);
      float maxHeightPx = inMaxDimensions.getHeight().to(GfxUnits.pixels);


      if (widthPx > maxWidthPx)
      {
         float scalingFactor = maxWidthPx / widthPx;

         widthPx = maxWidthPx;
         heightPx = heightPx * scalingFactor;
      }

      if (heightPx > maxHeightPx)
      {
         float scalingFactor = maxHeightPx / heightPx;

         widthPx = widthPx * scalingFactor;
         heightPx = maxHeightPx;
      }

      return new GfxSize2D().setWidth(new Pixels(widthPx)).setHeight(new Pixels(heightPx));
   }

}