class Shotstack::Offset
Offsets the position of an asset horizontally or vertically by a relative distance.
Attributes
Offset
an asset on the horizontal axis (left or right), range varies from -1 to 1. Positive numbers move the asset right, negative left. For all assets except titles the distance moved is relative to the width of the viewport - i.e. an X offset of 0.5 will move the asset half the screen width to the right.
Offset
an asset on the vertical axis (up or down), range varies from -1 to 1. Positive numbers move the asset up, negative down. For all assets except titles the distance moved is relative to the height of the viewport - i.e. an Y offset of 0.5 will move the asset up half the screen height.
Public Class Methods
Returns all the JSON keys this model knows about
# File lib/shotstack/models/offset.rb, line 34 def self.acceptable_attributes attribute_map.values end
Attribute mapping from ruby-style variable name to JSON key.
# File lib/shotstack/models/offset.rb, line 26 def self.attribute_map { :'x' => :'x', :'y' => :'y' } end
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/offset.rb, line 165 def self.build_from_hash(attributes) new.build_from_hash(attributes) end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/shotstack/models/offset.rb, line 54 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Shotstack::Offset` 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::Offset`. 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?(:'x') self.x = attributes[:'x'] else self.x = 0 end if attributes.key?(:'y') self.y = attributes[:'y'] else self.y = 0 end end
List of attributes with nullable: true
# File lib/shotstack/models/offset.rb, line 47 def self.openapi_nullable Set.new([ ]) end
Attribute type mapping.
# File lib/shotstack/models/offset.rb, line 39 def self.openapi_types { :'x' => :'Float', :'y' => :'Float' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/shotstack/models/offset.rb, line 143 def ==(o) return true if self.equal?(o) self.class == o.class && x == o.x && y == o.y end
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/offset.rb, line 195 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
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/offset.rb, line 266 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
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/offset.rb, line 172 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
@see the `==` method @param [Object] Object to be compared
# File lib/shotstack/models/offset.rb, line 152 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/shotstack/models/offset.rb, line 158 def hash [x, y].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/shotstack/models/offset.rb, line 82 def list_invalid_properties invalid_properties = Array.new if !@x.nil? && @x > 1 invalid_properties.push('invalid value for "x", must be smaller than or equal to 1.') end if !@x.nil? && @x < -1 invalid_properties.push('invalid value for "x", must be greater than or equal to -1.') end if !@y.nil? && @y > 1 invalid_properties.push('invalid value for "y", must be smaller than or equal to 1.') end if !@y.nil? && @y < -1 invalid_properties.push('invalid value for "y", must be greater than or equal to -1.') end invalid_properties end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/shotstack/models/offset.rb, line 248 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/shotstack/models/offset.rb, line 236 def to_s to_hash.to_s end
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/shotstack/models/offset.rb, line 105 def valid? return false if !@x.nil? && @x > 1 return false if !@x.nil? && @x < -1 return false if !@y.nil? && @y > 1 return false if !@y.nil? && @y < -1 true end
Custom attribute writer method with validation @param [Object] x Value to be assigned
# File lib/shotstack/models/offset.rb, line 115 def x=(x) if !x.nil? && x > 1 fail ArgumentError, 'invalid value for "x", must be smaller than or equal to 1.' end if !x.nil? && x < -1 fail ArgumentError, 'invalid value for "x", must be greater than or equal to -1.' end @x = x end
Custom attribute writer method with validation @param [Object] y Value to be assigned
# File lib/shotstack/models/offset.rb, line 129 def y=(y) if !y.nil? && y > 1 fail ArgumentError, 'invalid value for "y", must be smaller than or equal to 1.' end if !y.nil? && y < -1 fail ArgumentError, 'invalid value for "y", must be greater than or equal to -1.' end @y = y end