class CloudmersiveImageRecognitionApiClient::DrawPolygonInstance
Polygon instance to draw on an image
Attributes
Border Color to use - can be a hex value (with #) or HTML common color name. Transparent colors are supported.
Width in pixels of the border. Pass in 0 to draw a polygon with no border
Fill Color to use - can be a hex value (with #) or HTML common color name. Transparent colors are supported. Leave blank to not fill the polygon.
Points (vertices) which comprise the polygon; valid polygons must have at least 3 points
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/cloudmersive-image-recognition-api-client/models/draw_polygon_instance.rb, line 31 def self.attribute_map { :'border_color' => :'BorderColor', :'border_width' => :'BorderWidth', :'fill_color' => :'FillColor', :'points' => :'Points' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/cloudmersive-image-recognition-api-client/models/draw_polygon_instance.rb, line 52 def initialize(attributes = {}) return unless attributes.is_a?(Hash) # convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v } if attributes.has_key?(:'BorderColor') self.border_color = attributes[:'BorderColor'] end if attributes.has_key?(:'BorderWidth') self.border_width = attributes[:'BorderWidth'] end if attributes.has_key?(:'FillColor') self.fill_color = attributes[:'FillColor'] end if attributes.has_key?(:'Points') if (value = attributes[:'Points']).is_a?(Array) self.points = value end end end
Attribute type mapping.
# File lib/cloudmersive-image-recognition-api-client/models/draw_polygon_instance.rb, line 41 def self.swagger_types { :'border_color' => :'String', :'border_width' => :'Float', :'fill_color' => :'String', :'points' => :'Array<PolygonPoint>' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/cloudmersive-image-recognition-api-client/models/draw_polygon_instance.rb, line 92 def ==(o) return true if self.equal?(o) self.class == o.class && border_color == o.border_color && border_width == o.border_width && fill_color == o.fill_color && points == o.points 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/cloudmersive-image-recognition-api-client/models/draw_polygon_instance.rb, line 137 def _deserialize(type, value) case type.to_sym when :DateTime DateTime.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 temp_model = CloudmersiveImageRecognitionApiClient.const_get(type).new temp_model.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/cloudmersive-image-recognition-api-client/models/draw_polygon_instance.rb, line 203 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/cloudmersive-image-recognition-api-client/models/draw_polygon_instance.rb, line 116 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.swagger_types.each_pair do |key, type| if 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 # or else data not found in attributes(hash), not an issue as the data can be optional end self end
@see the `==` method @param [Object] Object to be compared
# File lib/cloudmersive-image-recognition-api-client/models/draw_polygon_instance.rb, line 103 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/cloudmersive-image-recognition-api-client/models/draw_polygon_instance.rb, line 109 def hash [border_color, border_width, fill_color, points].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/cloudmersive-image-recognition-api-client/models/draw_polygon_instance.rb, line 79 def list_invalid_properties invalid_properties = Array.new invalid_properties end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/cloudmersive-image-recognition-api-client/models/draw_polygon_instance.rb, line 189 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) next if value.nil? hash[param] = _to_hash(value) end hash end
Returns the string representation of the object @return [String] String presentation of the object
# File lib/cloudmersive-image-recognition-api-client/models/draw_polygon_instance.rb, line 177 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/cloudmersive-image-recognition-api-client/models/draw_polygon_instance.rb, line 86 def valid? true end