Class: GroupDocsViewerCloud::CadOptions

Inherits:
Object
  • Object
show all
Defined in:
lib/groupdocs_viewer_cloud/models/cad_options.rb

Overview

Rendering options for CAD file formats. CAD file formats include files with extensions: .dwg, .dxf, .dgn, .ifc, .stl

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CadOptions

Initializes the object

Parameters:

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

    Model attributes in the form of hash



83
84
85
86
87
88
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
115
116
117
118
119
120
121
 
# File 'lib/groupdocs_viewer_cloud/models/cad_options.rb', line 83

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

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

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

  if attributes.key?(:'Tiles')
    if (value = attributes[:'Tiles']).is_a?(Array)
      self.tiles = value
    end
  end

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

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

  if attributes.key?(:'Layers')
    if (value = attributes[:'Layers']).is_a?(Array)
      self.layers = value
    end
  end

end

Instance Attribute Details

#height ⇒ Object

Height of the output result in pixels



41
42
43
 
# File 'lib/groupdocs_viewer_cloud/models/cad_options.rb', line 41

def height
  @height
end

#layers ⇒ Object

The CAD drawing layers to render By default all layers are rendered; Layer names are case-sensitive



53
54
55
 
# File 'lib/groupdocs_viewer_cloud/models/cad_options.rb', line 53

def layers
  @layers
end

#layout_name ⇒ Object

The name of the specific layout to render. Layout name is case-sensitive



50
51
52
 
# File 'lib/groupdocs_viewer_cloud/models/cad_options.rb', line 50

def layout_name
  @layout_name
end

#render_layouts ⇒ Object

Indicates whether layouts from CAD document should be rendered



47
48
49
 
# File 'lib/groupdocs_viewer_cloud/models/cad_options.rb', line 47

def render_layouts
  @render_layouts
end

#scale_factor ⇒ Object

Scale factor allows to change the size of the output document. Values higher than 1 will enlarge output result and values between 0 and 1 will make output result smaller. This option is ignored when either Height or Width options are set.



35
36
37
 
# File 'lib/groupdocs_viewer_cloud/models/cad_options.rb', line 35

def scale_factor
  @scale_factor
end

#tiles ⇒ Object

The drawing regions to render This option supported only for DWG and DWT file types The RenderLayouts and LayoutName options are ignored when rendering by tiles



44
45
46
 
# File 'lib/groupdocs_viewer_cloud/models/cad_options.rb', line 44

def tiles
  @tiles
end

#width ⇒ Object

Width of the output result in pixels



38
39
40
 
# File 'lib/groupdocs_viewer_cloud/models/cad_options.rb', line 38

def width
  @width
end

Class Method Details

.attribute_map ⇒ Object

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



56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/groupdocs_viewer_cloud/models/cad_options.rb', line 56

def self.attribute_map
  {
    :'scale_factor' => :'ScaleFactor',
    :'width' => :'Width',
    :'height' => :'Height',
    :'tiles' => :'Tiles',
    :'render_layouts' => :'RenderLayouts',
    :'layout_name' => :'LayoutName',
    :'layers' => :'Layers'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/groupdocs_viewer_cloud/models/cad_options.rb', line 69

def self.swagger_types
  {
    :'scale_factor' => :'Float',
    :'width' => :'Integer',
    :'height' => :'Integer',
    :'tiles' => :'Array<Tile>',
    :'render_layouts' => :'BOOLEAN',
    :'layout_name' => :'String',
    :'layers' => :'Array<String>'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/groupdocs_viewer_cloud/models/cad_options.rb', line 158

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
      scale_factor == other.scale_factor &&
      width == other.width &&
      height == other.height &&
      tiles == other.tiles &&
      render_layouts == other.render_layouts &&
      layout_name == other.layout_name &&
      layers == other.layers
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



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
 
# File 'lib/groupdocs_viewer_cloud/models/cad_options.rb', line 215

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    Date.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 = GroupDocsViewerCloud.const_get(type).new
    temp_model.build_from_hash(value)
  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



282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/groupdocs_viewer_cloud/models/cad_options.rb', line 282

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



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/groupdocs_viewer_cloud/models/cad_options.rb', line 191

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    pname = uncap(self.class.attribute_map[key]).intern
    value = attributes[pname]
    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 value.is_a?(Array)
        self.send("#{key}=", value.map { |v| _deserialize($1, v) })
      end
    elsif !value.nil?
      self.send("#{key}=", _deserialize(type, value))
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


172
173
174
 
# File 'lib/groupdocs_viewer_cloud/models/cad_options.rb', line 172

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



178
179
180
 
# File 'lib/groupdocs_viewer_cloud/models/cad_options.rb', line 178

def hash
  [scale_factor, width, height, tiles, render_layouts, layout_name, layers].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properies with the reasons



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/groupdocs_viewer_cloud/models/cad_options.rb', line 125

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

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

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

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

  return 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



262
263
264
 
# File 'lib/groupdocs_viewer_cloud/models/cad_options.rb', line 262

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



268
269
270
271
272
273
274
275
276
 
# File 'lib/groupdocs_viewer_cloud/models/cad_options.rb', line 268

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



256
257
258
 
# File 'lib/groupdocs_viewer_cloud/models/cad_options.rb', line 256

def to_s
  to_hash.to_s
end

#uncap(str) ⇒ Object

Downcases first letter.

Returns:

  • downcased string



184
185
186
 
# File 'lib/groupdocs_viewer_cloud/models/cad_options.rb', line 184

def uncap(str)
  str[0, 1].downcase + str[1..-1]
end

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



148
149
150
151
152
153
154
 
# File 'lib/groupdocs_viewer_cloud/models/cad_options.rb', line 148

def valid?
  return false if @scale_factor.nil?
  return false if @width.nil?
  return false if @height.nil?
  return false if @render_layouts.nil?
  return true
end