class Shotstack::Crop

Crop the sides of an asset by a relative amount. The size of the crop is specified using a scale between 0 and 1, relative to the screen width - i.e a left crop of 0.5 will crop half of the asset from the left, a top crop of 0.25 will crop the top by quarter of the asset.

Attributes

bottom[RW]

Crop from the bottom of the asset

left[RW]

Crop from the left of the asset

right[RW]

Crop from the left of the asset

top[RW]

Crop from the top of the asset

Public Class Methods

acceptable_attributes() click to toggle source

Returns all the JSON keys this model knows about

# File lib/shotstack/models/crop.rb, line 42
def self.acceptable_attributes
  attribute_map.values
end
attribute_map() click to toggle source

Attribute mapping from ruby-style variable name to JSON key.

# File lib/shotstack/models/crop.rb, line 32
def self.attribute_map
  {
    :'top' => :'top',
    :'bottom' => :'bottom',
    :'left' => :'left',
    :'right' => :'right'
  }
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/shotstack/models/crop.rb, line 229
def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/shotstack/models/crop.rb, line 64
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Shotstack::Crop` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Shotstack::Crop`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'top')
    self.top = attributes[:'top']
  end

  if attributes.key?(:'bottom')
    self.bottom = attributes[:'bottom']
  end

  if attributes.key?(:'left')
    self.left = attributes[:'left']
  end

  if attributes.key?(:'right')
    self.right = attributes[:'right']
  end
end
openapi_nullable() click to toggle source

List of attributes with nullable: true

# File lib/shotstack/models/crop.rb, line 57
def self.openapi_nullable
  Set.new([
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/shotstack/models/crop.rb, line 47
def self.openapi_types
  {
    :'top' => :'Float',
    :'bottom' => :'Float',
    :'left' => :'Float',
    :'right' => :'Float'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/shotstack/models/crop.rb, line 205
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      top == o.top &&
      bottom == o.bottom &&
      left == o.left &&
      right == o.right
end
_deserialize(type, value) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/shotstack/models/crop.rb, line 259
def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = Shotstack.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end
_to_hash(value) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/shotstack/models/crop.rb, line 330
def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end
bottom=(bottom) click to toggle source

Custom attribute writer method with validation @param [Object] bottom Value to be assigned

# File lib/shotstack/models/crop.rb, line 163
def bottom=(bottom)
  if !bottom.nil? && bottom > 1
    fail ArgumentError, 'invalid value for "bottom", must be smaller than or equal to 1.'
  end

  if !bottom.nil? && bottom < 0
    fail ArgumentError, 'invalid value for "bottom", must be greater than or equal to 0.'
  end

  @bottom = bottom
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/shotstack/models/crop.rb, line 236
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end
eql?(o) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/shotstack/models/crop.rb, line 216
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Integer] Hash code

# File lib/shotstack/models/crop.rb, line 222
def hash
  [top, bottom, left, right].hash
end
left=(left) click to toggle source

Custom attribute writer method with validation @param [Object] left Value to be assigned

# File lib/shotstack/models/crop.rb, line 177
def left=(left)
  if !left.nil? && left > 1
    fail ArgumentError, 'invalid value for "left", must be smaller than or equal to 1.'
  end

  if !left.nil? && left < 0
    fail ArgumentError, 'invalid value for "left", must be greater than or equal to 0.'
  end

  @left = left
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/shotstack/models/crop.rb, line 96
def list_invalid_properties
  invalid_properties = Array.new
  if !@top.nil? && @top > 1
    invalid_properties.push('invalid value for "top", must be smaller than or equal to 1.')
  end

  if !@top.nil? && @top < 0
    invalid_properties.push('invalid value for "top", must be greater than or equal to 0.')
  end

  if !@bottom.nil? && @bottom > 1
    invalid_properties.push('invalid value for "bottom", must be smaller than or equal to 1.')
  end

  if !@bottom.nil? && @bottom < 0
    invalid_properties.push('invalid value for "bottom", must be greater than or equal to 0.')
  end

  if !@left.nil? && @left > 1
    invalid_properties.push('invalid value for "left", must be smaller than or equal to 1.')
  end

  if !@left.nil? && @left < 0
    invalid_properties.push('invalid value for "left", must be greater than or equal to 0.')
  end

  if !@right.nil? && @right > 1
    invalid_properties.push('invalid value for "right", must be smaller than or equal to 1.')
  end

  if !@right.nil? && @right < 0
    invalid_properties.push('invalid value for "right", must be greater than or equal to 0.')
  end

  invalid_properties
end
right=(right) click to toggle source

Custom attribute writer method with validation @param [Object] right Value to be assigned

# File lib/shotstack/models/crop.rb, line 191
def right=(right)
  if !right.nil? && right > 1
    fail ArgumentError, 'invalid value for "right", must be smaller than or equal to 1.'
  end

  if !right.nil? && right < 0
    fail ArgumentError, 'invalid value for "right", must be greater than or equal to 0.'
  end

  @right = right
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/shotstack/models/crop.rb, line 306
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/shotstack/models/crop.rb, line 312
def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end
to_s() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/shotstack/models/crop.rb, line 300
def to_s
  to_hash.to_s
end
top=(top) click to toggle source

Custom attribute writer method with validation @param [Object] top Value to be assigned

# File lib/shotstack/models/crop.rb, line 149
def top=(top)
  if !top.nil? && top > 1
    fail ArgumentError, 'invalid value for "top", must be smaller than or equal to 1.'
  end

  if !top.nil? && top < 0
    fail ArgumentError, 'invalid value for "top", must be greater than or equal to 0.'
  end

  @top = top
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/shotstack/models/crop.rb, line 135
def valid?
  return false if !@top.nil? && @top > 1
  return false if !@top.nil? && @top < 0
  return false if !@bottom.nil? && @bottom > 1
  return false if !@bottom.nil? && @bottom < 0
  return false if !@left.nil? && @left > 1
  return false if !@left.nil? && @left < 0
  return false if !@right.nil? && @right > 1
  return false if !@right.nil? && @right < 0
  true
end