Class: AsposeSlidesCloud::LightRig

Inherits:
Object
  • Object
show all
Defined in:
lib/aspose_slides_cloud/models/light_rig.rb

Overview

Light rig

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ LightRig

Initializes the object

Parameters:

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

    Model attributes in the form of hash



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
# File 'lib/aspose_slides_cloud/models/light_rig.rb', line 89

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?(:'Direction')
    self.direction = attributes[:'Direction']
  end

  if attributes.has_key?(:'LightType')
    self.light_type = attributes[:'LightType']
  end

  if attributes.has_key?(:'XRotation')
    self.x_rotation = attributes[:'XRotation']
  end

  if attributes.has_key?(:'YRotation')
    self.y_rotation = attributes[:'YRotation']
  end

  if attributes.has_key?(:'ZRotation')
    self.z_rotation = attributes[:'ZRotation']
  end
end

Instance Attribute Details

#directionObject

Light direction



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

def direction
  @direction
end

#light_typeObject

Light type



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

def light_type
  @light_type
end

#x_rotationObject

XRotation



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

def x_rotation
  @x_rotation
end

#y_rotationObject

YRotation



38
39
40
# File 'lib/aspose_slides_cloud/models/light_rig.rb', line 38

def y_rotation
  @y_rotation
end

#z_rotationObject

ZRotation



41
42
43
# File 'lib/aspose_slides_cloud/models/light_rig.rb', line 41

def z_rotation
  @z_rotation
end

Class Method Details

.attribute_mapObject

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



66
67
68
69
70
71
72
73
74
# File 'lib/aspose_slides_cloud/models/light_rig.rb', line 66

def self.attribute_map
  {
    :'direction' => :'Direction',
    :'light_type' => :'LightType',
    :'x_rotation' => :'XRotation',
    :'y_rotation' => :'YRotation',
    :'z_rotation' => :'ZRotation',
  }
end

.swagger_typesObject

Attribute type mapping.



77
78
79
80
81
82
83
84
85
# File 'lib/aspose_slides_cloud/models/light_rig.rb', line 77

def self.swagger_types
  {
    :'direction' => :'String',
    :'light_type' => :'String',
    :'x_rotation' => :'Float',
    :'y_rotation' => :'Float',
    :'z_rotation' => :'Float',
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



155
156
157
158
159
160
161
162
163
# File 'lib/aspose_slides_cloud/models/light_rig.rb', line 155

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      direction == o.direction &&
      light_type == o.light_type &&
      x_rotation == o.x_rotation &&
      y_rotation == o.y_rotation &&
      z_rotation == o.z_rotation
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



213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
# File 'lib/aspose_slides_cloud/models/light_rig.rb', line 213

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



287
288
289
290
291
292
293
294
295
296
297
298
299
# File 'lib/aspose_slides_cloud/models/light_rig.rb', line 287

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



180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
# File 'lib/aspose_slides_cloud/models/light_rig.rb', line 180

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


167
168
169
# File 'lib/aspose_slides_cloud/models/light_rig.rb', line 167

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



173
174
175
# File 'lib/aspose_slides_cloud/models/light_rig.rb', line 173

def hash
  [direction, light_type, x_rotation, y_rotation, z_rotation].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



118
119
120
121
# File 'lib/aspose_slides_cloud/models/light_rig.rb', line 118

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



267
268
269
# File 'lib/aspose_slides_cloud/models/light_rig.rb', line 267

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



273
274
275
276
277
278
279
280
281
# File 'lib/aspose_slides_cloud/models/light_rig.rb', line 273

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



261
262
263
# File 'lib/aspose_slides_cloud/models/light_rig.rb', line 261

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



125
126
127
128
129
130
131
# File 'lib/aspose_slides_cloud/models/light_rig.rb', line 125

def valid?
  direction_validator = EnumAttributeValidator.new('String', ['TopLeft', 'Top', 'TopRight', 'Right', 'BottomRight', 'Bottom', 'BottomLeft', 'Left', 'NotDefined'])
  return false unless direction_validator.valid?(@direction)
  light_type_validator = EnumAttributeValidator.new('String', ['Balanced', 'BrightRoom', 'Chilly', 'Contrasting', 'Flat', 'Flood', 'Freezing', 'Glow', 'Harsh', 'LegacyFlat1', 'LegacyFlat2', 'LegacyFlat3', 'LegacyFlat4', 'LegacyHarsh1', 'LegacyHarsh2', 'LegacyHarsh3', 'LegacyHarsh4', 'LegacyNormal1', 'LegacyNormal2', 'LegacyNormal3', 'LegacyNormal4', 'Morning', 'Soft', 'Sunrise', 'Sunset', 'ThreePt', 'TwoPt', 'NotDefined'])
  return false unless light_type_validator.valid?(@light_type)
  true
end