size.go

/*
   Copyright 2011-2014 starfish authors

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

     http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.
*/
package starfish

import "strconv"

/*
  Used to track a Cartesian size.
*/
type Size struct {
	Width  int "json: width"
	Height int "json: height"
}

//Compares the value of this Size to the value of the given Size.
func (me *Size) Equals(p Size) bool {
	return me.Width == p.Width && me.Height == p.Height
}

/*
  Sets the width attribute for this Size.
  Takes:
  	width - the new width of this Size
*/
func (me *Size) SetWidth(width int) {
	me.Width = width
}

/*
  Sets the width attribute for this Size.
  Takes:
	height - the new height of this Size
*/
func (me *Size) SetHeight(height int) {
	me.Height = height
}

/*
  Sets the dimensions of this Size.
  Takes:
	width - the new width of this Size
	height - the new height of this Size
*/
func (me *Size) SetSize(width int, height int) {
	me.Width = width
	me.Height = height
}

/*
  Sets the dimensions of this Size according to the given Size.
  Takes:
	size - the Size object representing the values this Size should take on
*/
func (me *Size) Set(size *Size) {
	me.SetSize(size.Width, size.Height)
}

/*
  Gets the width attribute of this Size.
  Returns:
	the width attribute of this Size
*/
func (me *Size) GetWidth() int {
	return me.Width
}

/*
  Gets the height attribute of this Size.
  Returns:
	the height attribute of this Size
*/
func (me *Size) GetHeight() int {
	return me.Height
}

/*
  Gets the width and height of this Size.
  Returns:
	width - the width attribute of this Size
	height - the height attribute of this Size
*/
func (me *Size) Get() (int, int) {
	return me.Width, me.Height
}

// Returns the value of this Point with the dimensions of the given added to its dimensions.
func (me Size) AddOf(size Size) (s Size) {
	s.Width = me.Width + size.Width
	s.Height = me.Height + size.Height
	return
}

// Adds the dimensions of the given Size to the dimensions of this Size.
func (me *Size) AddTo(size Size) {
	me.Width += size.Width
	me.Height += size.Height
}

// Returns the value of this Size with the dimensions of the given subracted from its dimensions.
func (me Size) SubtractOf(size Size) (s Size) {
	s.Width = me.Width - size.Width
	s.Height = me.Height - size.Height
	return
}

// Subracts the coordinates of the given Size from the coordinates of this Size.
func (me *Size) SubtractFrom(size Size) {
	me.Width -= size.Width
	me.Height -= size.Height
}

// Returns the value of this Size with the dimensions divided by the dimesions of the given.
func (me Size) DivideOf(size Size) (s Size) {
	s.Width = me.Width / size.Width
	s.Height = me.Height / size.Height
	return
}

// Divideds the coordinates of this given Size by the coordinates of the given Size.
func (me *Size) DivideBy(size Size) {
	me.Width /= size.Width
	me.Height /= size.Height
}

// Returns this Size as a Point.
func (me Size) ToPoint() Point {
	return Point{me.Width, me.Height}
}

//A string representation of this Size for use as a map key.
func (me *Size) String() string {
	return "(" + strconv.Itoa(me.Width) + ", " + strconv.Itoa(me.Height) + ")"
}