Class: AsposeSlidesCloud::HslEffect

Inherits:
ImageTransformEffect show all
Defined in:
lib/aspose_slides_cloud/models/hsl_effect.rb

Overview

Represents a Hue/Saturation/Luminance effect.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Attributes inherited from ImageTransformEffect

#type

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ HslEffect

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/aspose_slides_cloud/models/hsl_effect.rb', line 79

def initialize(attributes = {})
  super

  if attributes.has_key?(:'Hue')
    self.hue = attributes[:'Hue']
  end

  if attributes.has_key?(:'Saturation')
    self.saturation = attributes[:'Saturation']
  end

  if attributes.has_key?(:'Luminance')
    self.luminance = attributes[:'Luminance']
  end
  self.type = 'Hsl'
end

Instance Attribute Details

#hue ⇒ Object

Hue



29
30
31
 
# File 'lib/aspose_slides_cloud/models/hsl_effect.rb', line 29

def hue
  @hue
end

#luminance ⇒ Object

Luminance



35
36
37
 
# File 'lib/aspose_slides_cloud/models/hsl_effect.rb', line 35

def luminance
  @luminance
end

#saturation ⇒ Object

Saturation



32
33
34
 
# File 'lib/aspose_slides_cloud/models/hsl_effect.rb', line 32

def saturation
  @saturation
end

Class Method Details

.attribute_map ⇒ Object

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



60
61
62
63
64
65
66
 
# File 'lib/aspose_slides_cloud/models/hsl_effect.rb', line 60

def self.attribute_map
  super.merge({
    :'hue' => :'Hue',
    :'saturation' => :'Saturation',
    :'luminance' => :'Luminance',
  })
end

.swagger_types ⇒ Object

Attribute type mapping.



69
70
71
72
73
74
75
 
# File 'lib/aspose_slides_cloud/models/hsl_effect.rb', line 69

def self.swagger_types
  super.merge({
    :'hue' => :'Float',
    :'saturation' => :'Float',
    :'luminance' => :'Float',
  })
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



127
128
129
130
131
132
133
134
 
# File 'lib/aspose_slides_cloud/models/hsl_effect.rb', line 127

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      type == o.type &&
      hue == o.hue &&
      saturation == o.saturation &&
      luminance == o.luminance
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/aspose_slides_cloud/models/hsl_effect.rb', line 184

def _deserialize(type, value)
  if value.nil?
    nil
  else
    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
      registry_type = AsposeSlidesCloud::TypeRegistry.get_type(type.to_s, value)
      if registry_type
        type = registry_type
      end
      temp_model = AsposeSlidesCloud.const_get(type).new
      temp_model.build_from_hash(value)
    end
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'lib/aspose_slides_cloud/models/hsl_effect.rb', line 258

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

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/aspose_slides_cloud/models/hsl_effect.rb', line 151

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    mapKey = self.class.attribute_map[key]
    if !mapKey.nil?
      val = attributes[mapKey]
      if val.nil?
        mapKeyString = mapKey.to_s
        mapKeyString[0] = mapKeyString[0].downcase
        mapKey = mapKeyString.to_sym
        val = attributes[mapKey]
      end
      if !val.nil?
        if type =~ /\AArray<(.*)>/i
          # check to ensure the input is an array given that the the attribute
          # is documented as an array but the input is not
          if val.is_a?(Array)
            self.send("#{key}=", val.map { |v| _deserialize($1, v) })
          end
        else
          self.send("#{key}=", _deserialize(type, val))
        end
      end
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


138
139
140
 
# File 'lib/aspose_slides_cloud/models/hsl_effect.rb', line 138

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



144
145
146
 
# File 'lib/aspose_slides_cloud/models/hsl_effect.rb', line 144

def hash
  [type, hue, saturation, luminance].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/aspose_slides_cloud/models/hsl_effect.rb', line 98

def list_invalid_properties
  invalid_properties = super
  if @hue.nil?
    invalid_properties.push('invalid value for "hue", hue cannot be nil.')
  end

  if @saturation.nil?
    invalid_properties.push('invalid value for "saturation", saturation cannot be nil.')
  end

  if @luminance.nil?
    invalid_properties.push('invalid value for "luminance", luminance cannot be nil.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



238
239
240
 
# File 'lib/aspose_slides_cloud/models/hsl_effect.rb', line 238

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



244
245
246
247
248
249
250
251
252
 
# File 'lib/aspose_slides_cloud/models/hsl_effect.rb', line 244

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

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



232
233
234
 
# File 'lib/aspose_slides_cloud/models/hsl_effect.rb', line 232

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



117
118
119
120
121
122
123
 
# File 'lib/aspose_slides_cloud/models/hsl_effect.rb', line 117

def valid?
  return false if !super
  return false if @hue.nil?
  return false if @saturation.nil?
  return false if @luminance.nil?
  true
end