class AsposeSlidesCloud::Effect

Represents comment of slide

Attributes

accelerate[RW]

The percentage of duration accelerate behavior effect.

after_animation_color[RW]

Defined an after animation color for effect. Applied when the AfterAnimationType property is set to Color.

after_animation_type[RW]

Defined an after animation color for effect.

animate_text_type[RW]

Preset class type.

auto_reverse[RW]

True to automatically play the animation in reverse after playing it in the forward direction.

decelerate[RW]

The percentage of duration decelerate behavior effect.

duration[RW]

The duration of animation effect.

paragraph_index[RW]

Paragraph index.

preset_class_type[RW]

Preset class type.

repeat_count[RW]

The number of times the effect should repeat.

repeat_duration[RW]

The number of times the effect should repeat.

repeat_until_end_slide[RW]

Specifies if the effect will repeat until the end of slide.

repeat_until_next_click[RW]

Specifies if the effect will repeat until the next click.

restart[RW]

The way for a effect to restart after complete.

rewind[RW]

This attribute specifies if the effect will rewind when done playing.

shape_index[RW]

Shape index.

speed[RW]

The percentage by which to speed up (or slow down) the timing.

stop_previous_sound[RW]

This attribute specifies if the animation effect stops the previous sound.

subtype[RW]

Effect subtype.

trigger_delay_time[RW]

Delay time after trigger.

trigger_type[RW]

Effect trigger type.

type[RW]

Effect type.

Public Class Methods

attribute_map() click to toggle source

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

# File lib/aspose_slides_cloud/models/effect.rb, line 95
def self.attribute_map
  {
    :'type' => :'Type',
    :'subtype' => :'Subtype',
    :'preset_class_type' => :'PresetClassType',
    :'animate_text_type' => :'AnimateTextType',
    :'shape_index' => :'ShapeIndex',
    :'paragraph_index' => :'ParagraphIndex',
    :'trigger_type' => :'TriggerType',
    :'accelerate' => :'Accelerate',
    :'auto_reverse' => :'AutoReverse',
    :'decelerate' => :'Decelerate',
    :'duration' => :'Duration',
    :'repeat_count' => :'RepeatCount',
    :'repeat_duration' => :'RepeatDuration',
    :'restart' => :'Restart',
    :'speed' => :'Speed',
    :'trigger_delay_time' => :'TriggerDelayTime',
    :'repeat_until_end_slide' => :'RepeatUntilEndSlide',
    :'repeat_until_next_click' => :'RepeatUntilNextClick',
    :'stop_previous_sound' => :'StopPreviousSound',
    :'rewind' => :'Rewind',
    :'after_animation_type' => :'AfterAnimationType',
    :'after_animation_color' => :'AfterAnimationColor',
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/aspose_slides_cloud/models/effect.rb, line 152
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?(:'Type')
    self.type = attributes[:'Type']
  end

  if attributes.has_key?(:'Subtype')
    self.subtype = attributes[:'Subtype']
  end

  if attributes.has_key?(:'PresetClassType')
    self.preset_class_type = attributes[:'PresetClassType']
  end

  if attributes.has_key?(:'AnimateTextType')
    self.animate_text_type = attributes[:'AnimateTextType']
  end

  if attributes.has_key?(:'ShapeIndex')
    self.shape_index = attributes[:'ShapeIndex']
  end

  if attributes.has_key?(:'ParagraphIndex')
    self.paragraph_index = attributes[:'ParagraphIndex']
  end

  if attributes.has_key?(:'TriggerType')
    self.trigger_type = attributes[:'TriggerType']
  end

  if attributes.has_key?(:'Accelerate')
    self.accelerate = attributes[:'Accelerate']
  end

  if attributes.has_key?(:'AutoReverse')
    self.auto_reverse = attributes[:'AutoReverse']
  end

  if attributes.has_key?(:'Decelerate')
    self.decelerate = attributes[:'Decelerate']
  end

  if attributes.has_key?(:'Duration')
    self.duration = attributes[:'Duration']
  end

  if attributes.has_key?(:'RepeatCount')
    self.repeat_count = attributes[:'RepeatCount']
  end

  if attributes.has_key?(:'RepeatDuration')
    self.repeat_duration = attributes[:'RepeatDuration']
  end

  if attributes.has_key?(:'Restart')
    self.restart = attributes[:'Restart']
  end

  if attributes.has_key?(:'Speed')
    self.speed = attributes[:'Speed']
  end

  if attributes.has_key?(:'TriggerDelayTime')
    self.trigger_delay_time = attributes[:'TriggerDelayTime']
  end

  if attributes.has_key?(:'RepeatUntilEndSlide')
    self.repeat_until_end_slide = attributes[:'RepeatUntilEndSlide']
  end

  if attributes.has_key?(:'RepeatUntilNextClick')
    self.repeat_until_next_click = attributes[:'RepeatUntilNextClick']
  end

  if attributes.has_key?(:'StopPreviousSound')
    self.stop_previous_sound = attributes[:'StopPreviousSound']
  end

  if attributes.has_key?(:'Rewind')
    self.rewind = attributes[:'Rewind']
  end

  if attributes.has_key?(:'AfterAnimationType')
    self.after_animation_type = attributes[:'AfterAnimationType']
  end

  if attributes.has_key?(:'AfterAnimationColor')
    self.after_animation_color = attributes[:'AfterAnimationColor']
  end
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/aspose_slides_cloud/models/effect.rb, line 123
def self.swagger_types
  {
    :'type' => :'String',
    :'subtype' => :'String',
    :'preset_class_type' => :'String',
    :'animate_text_type' => :'String',
    :'shape_index' => :'Integer',
    :'paragraph_index' => :'Integer',
    :'trigger_type' => :'String',
    :'accelerate' => :'Float',
    :'auto_reverse' => :'BOOLEAN',
    :'decelerate' => :'Float',
    :'duration' => :'Float',
    :'repeat_count' => :'Float',
    :'repeat_duration' => :'Float',
    :'restart' => :'String',
    :'speed' => :'Float',
    :'trigger_delay_time' => :'Float',
    :'repeat_until_end_slide' => :'BOOLEAN',
    :'repeat_until_next_click' => :'BOOLEAN',
    :'stop_previous_sound' => :'BOOLEAN',
    :'rewind' => :'BOOLEAN',
    :'after_animation_type' => :'String',
    :'after_animation_color' => :'String',
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/aspose_slides_cloud/models/effect.rb, line 351
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      type == o.type &&
      subtype == o.subtype &&
      preset_class_type == o.preset_class_type &&
      animate_text_type == o.animate_text_type &&
      shape_index == o.shape_index &&
      paragraph_index == o.paragraph_index &&
      trigger_type == o.trigger_type &&
      accelerate == o.accelerate &&
      auto_reverse == o.auto_reverse &&
      decelerate == o.decelerate &&
      duration == o.duration &&
      repeat_count == o.repeat_count &&
      repeat_duration == o.repeat_duration &&
      restart == o.restart &&
      speed == o.speed &&
      trigger_delay_time == o.trigger_delay_time &&
      repeat_until_end_slide == o.repeat_until_end_slide &&
      repeat_until_next_click == o.repeat_until_next_click &&
      stop_previous_sound == o.stop_previous_sound &&
      rewind == o.rewind &&
      after_animation_type == o.after_animation_type &&
      after_animation_color == o.after_animation_color
end
after_animation_type=(after_animation_type) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] after_animation_type Object to be assigned

# File lib/aspose_slides_cloud/models/effect.rb, line 341
def after_animation_type=(after_animation_type)
  validator = EnumAttributeValidator.new('String', ['DoNotDim', 'Color', 'HideAfterAnimation', 'HideOnNextMouseClick'])
  unless validator.valid?(after_animation_type)
    fail ArgumentError, 'invalid value for "after_animation_type", must be one of #{validator.allowable_values}.'
  end
  @after_animation_type = after_animation_type
end
animate_text_type=(animate_text_type) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] animate_text_type Object to be assigned

# File lib/aspose_slides_cloud/models/effect.rb, line 311
def animate_text_type=(animate_text_type)
  validator = EnumAttributeValidator.new('String', ['AllAtOnce', 'ByWord', 'ByLetter'])
  unless validator.valid?(animate_text_type)
    fail ArgumentError, 'invalid value for "animate_text_type", must be one of #{validator.allowable_values}.'
  end
  @animate_text_type = animate_text_type
end
eql?(o) click to toggle source

@see the ‘==` method @param [Object] Object to be compared

# File lib/aspose_slides_cloud/models/effect.rb, line 380
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/aspose_slides_cloud/models/effect.rb, line 386
def hash
  [type, subtype, preset_class_type, animate_text_type, shape_index, paragraph_index, trigger_type, accelerate, auto_reverse, decelerate, duration, repeat_count, repeat_duration, restart, speed, trigger_delay_time, repeat_until_end_slide, repeat_until_next_click, stop_previous_sound, rewind, after_animation_type, after_animation_color].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/aspose_slides_cloud/models/effect.rb, line 249
def list_invalid_properties
  invalid_properties = Array.new
  if @shape_index.nil?
    invalid_properties.push('invalid value for "shape_index", shape_index cannot be nil.')
  end

  invalid_properties
end
preset_class_type=(preset_class_type) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] preset_class_type Object to be assigned

# File lib/aspose_slides_cloud/models/effect.rb, line 301
def preset_class_type=(preset_class_type)
  validator = EnumAttributeValidator.new('String', ['Entrance', 'Exit', 'Emphasis', 'Path', 'MediaCall', 'OLEActionVerbs'])
  unless validator.valid?(preset_class_type)
    fail ArgumentError, 'invalid value for "preset_class_type", must be one of #{validator.allowable_values}.'
  end
  @preset_class_type = preset_class_type
end
restart=(restart) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] restart Object to be assigned

# File lib/aspose_slides_cloud/models/effect.rb, line 331
def restart=(restart)
  validator = EnumAttributeValidator.new('String', ['Always', 'WhenNotActive', 'Never', 'NotDefined'])
  unless validator.valid?(restart)
    fail ArgumentError, 'invalid value for "restart", must be one of #{validator.allowable_values}.'
  end
  @restart = restart
end
subtype=(subtype) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] subtype Object to be assigned

# File lib/aspose_slides_cloud/models/effect.rb, line 291
def subtype=(subtype)
  validator = EnumAttributeValidator.new('String', ['None', 'Across', 'Bottom', 'BottomLeft', 'BottomRight', 'Center', 'Clockwise', 'CounterClockwise', 'GradualAndCycleClockwise', 'GradualAndCycleCounterClockwise', 'Down', 'DownLeft', 'DownRight', 'FontAllCaps', 'FontBold', 'FontItalic', 'FontShadow', 'FontStrikethrough', 'FontUnderline', 'Gradual', 'Horizontal', 'HorizontalIn', 'HorizontalOut', 'In', 'InBottom', 'InCenter', 'InSlightly', 'Instant', 'Left', 'OrdinalMask', 'Out', 'OutBottom', 'OutCenter', 'OutSlightly', 'Right', 'Slightly', 'Top', 'TopLeft', 'TopRight', 'Up', 'UpLeft', 'UpRight', 'Vertical', 'VerticalIn', 'VerticalOut', 'Wheel1', 'Wheel2', 'Wheel3', 'Wheel4', 'Wheel8'])
  unless validator.valid?(subtype)
    fail ArgumentError, 'invalid value for "subtype", must be one of #{validator.allowable_values}.'
  end
  @subtype = subtype
end
trigger_type=(trigger_type) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] trigger_type Object to be assigned

# File lib/aspose_slides_cloud/models/effect.rb, line 321
def trigger_type=(trigger_type)
  validator = EnumAttributeValidator.new('String', ['AfterPrevious', 'OnClick', 'WithPrevious'])
  unless validator.valid?(trigger_type)
    fail ArgumentError, 'invalid value for "trigger_type", must be one of #{validator.allowable_values}.'
  end
  @trigger_type = trigger_type
end
type=(type) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] type Object to be assigned

# File lib/aspose_slides_cloud/models/effect.rb, line 281
def type=(type)
  validator = EnumAttributeValidator.new('String', ['Appear', 'CurveUpDown', 'Ascend', 'Blast', 'Blinds', 'Blink', 'BoldFlash', 'BoldReveal', 'Boomerang', 'Bounce', 'Box', 'BrushOnColor', 'BrushOnUnderline', 'CenterRevolve', 'ChangeFillColor', 'ChangeFont', 'ChangeFontColor', 'ChangeFontSize', 'ChangeFontStyle', 'ChangeLineColor', 'Checkerboard', 'Circle', 'ColorBlend', 'ColorTypewriter', 'ColorWave', 'ComplementaryColor', 'ComplementaryColor2', 'Compress', 'ContrastingColor', 'Crawl', 'Credits', 'Custom', 'Darken', 'Desaturate', 'Descend', 'Diamond', 'Dissolve', 'EaseInOut', 'Expand', 'Fade', 'FadedSwivel', 'FadedZoom', 'FlashBulb', 'FlashOnce', 'Flicker', 'Flip', 'Float', 'Fly', 'Fold', 'Glide', 'GrowAndTurn', 'GrowShrink', 'GrowWithColor', 'Lighten', 'LightSpeed', 'MediaPause', 'MediaPlay', 'MediaStop', 'Path4PointStar', 'Path5PointStar', 'Path6PointStar', 'Path8PointStar', 'PathArcDown', 'PathArcLeft', 'PathArcRight', 'PathArcUp', 'PathBean', 'PathBounceLeft', 'PathBounceRight', 'PathBuzzsaw', 'PathCircle', 'PathCrescentMoon', 'PathCurvedSquare', 'PathCurvedX', 'PathCurvyLeft', 'PathCurvyRight', 'PathCurvyStar', 'PathDecayingWave', 'PathDiagonalDownRight', 'PathDiagonalUpRight', 'PathDiamond', 'PathDown', 'PathEqualTriangle', 'PathFigure8Four', 'PathFootball', 'PathFunnel', 'PathHeart', 'PathHeartbeat', 'PathHexagon', 'PathHorizontalFigure8', 'PathInvertedSquare', 'PathInvertedTriangle', 'PathLeft', 'PathLoopdeLoop', 'PathNeutron', 'PathOctagon', 'PathParallelogram', 'PathPeanut', 'PathPentagon', 'PathPlus', 'PathPointyStar', 'PathRight', 'PathRightTriangle', 'PathSCurve1', 'PathSCurve2', 'PathSineWave', 'PathSpiralLeft', 'PathSpiralRight', 'PathSpring', 'PathSquare', 'PathStairsDown', 'PathSwoosh', 'PathTeardrop', 'PathTrapezoid', 'PathTurnDown', 'PathTurnRight', 'PathTurnUp', 'PathTurnUpRight', 'PathUp', 'PathUser', 'PathVerticalFigure8', 'PathWave', 'PathZigzag', 'Peek', 'Pinwheel', 'Plus', 'RandomBars', 'RandomEffects', 'RiseUp', 'Shimmer', 'Sling', 'Spin', 'Spinner', 'Spiral', 'Split', 'Stretch', 'Strips', 'StyleEmphasis', 'Swish', 'Swivel', 'Teeter', 'Thread', 'Transparency', 'Unfold', 'VerticalGrow', 'Wave', 'Wedge', 'Wheel', 'Whip', 'Wipe', 'Magnify', 'Zoom', 'OLEObjectShow', 'OLEObjectEdit', 'OLEObjectOpen'])
  unless validator.valid?(type)
    fail ArgumentError, 'invalid value for "type", must be one of #{validator.allowable_values}.'
  end
  @type = type
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/aspose_slides_cloud/models/effect.rb, line 260
def valid?
  type_validator = EnumAttributeValidator.new('String', ['Appear', 'CurveUpDown', 'Ascend', 'Blast', 'Blinds', 'Blink', 'BoldFlash', 'BoldReveal', 'Boomerang', 'Bounce', 'Box', 'BrushOnColor', 'BrushOnUnderline', 'CenterRevolve', 'ChangeFillColor', 'ChangeFont', 'ChangeFontColor', 'ChangeFontSize', 'ChangeFontStyle', 'ChangeLineColor', 'Checkerboard', 'Circle', 'ColorBlend', 'ColorTypewriter', 'ColorWave', 'ComplementaryColor', 'ComplementaryColor2', 'Compress', 'ContrastingColor', 'Crawl', 'Credits', 'Custom', 'Darken', 'Desaturate', 'Descend', 'Diamond', 'Dissolve', 'EaseInOut', 'Expand', 'Fade', 'FadedSwivel', 'FadedZoom', 'FlashBulb', 'FlashOnce', 'Flicker', 'Flip', 'Float', 'Fly', 'Fold', 'Glide', 'GrowAndTurn', 'GrowShrink', 'GrowWithColor', 'Lighten', 'LightSpeed', 'MediaPause', 'MediaPlay', 'MediaStop', 'Path4PointStar', 'Path5PointStar', 'Path6PointStar', 'Path8PointStar', 'PathArcDown', 'PathArcLeft', 'PathArcRight', 'PathArcUp', 'PathBean', 'PathBounceLeft', 'PathBounceRight', 'PathBuzzsaw', 'PathCircle', 'PathCrescentMoon', 'PathCurvedSquare', 'PathCurvedX', 'PathCurvyLeft', 'PathCurvyRight', 'PathCurvyStar', 'PathDecayingWave', 'PathDiagonalDownRight', 'PathDiagonalUpRight', 'PathDiamond', 'PathDown', 'PathEqualTriangle', 'PathFigure8Four', 'PathFootball', 'PathFunnel', 'PathHeart', 'PathHeartbeat', 'PathHexagon', 'PathHorizontalFigure8', 'PathInvertedSquare', 'PathInvertedTriangle', 'PathLeft', 'PathLoopdeLoop', 'PathNeutron', 'PathOctagon', 'PathParallelogram', 'PathPeanut', 'PathPentagon', 'PathPlus', 'PathPointyStar', 'PathRight', 'PathRightTriangle', 'PathSCurve1', 'PathSCurve2', 'PathSineWave', 'PathSpiralLeft', 'PathSpiralRight', 'PathSpring', 'PathSquare', 'PathStairsDown', 'PathSwoosh', 'PathTeardrop', 'PathTrapezoid', 'PathTurnDown', 'PathTurnRight', 'PathTurnUp', 'PathTurnUpRight', 'PathUp', 'PathUser', 'PathVerticalFigure8', 'PathWave', 'PathZigzag', 'Peek', 'Pinwheel', 'Plus', 'RandomBars', 'RandomEffects', 'RiseUp', 'Shimmer', 'Sling', 'Spin', 'Spinner', 'Spiral', 'Split', 'Stretch', 'Strips', 'StyleEmphasis', 'Swish', 'Swivel', 'Teeter', 'Thread', 'Transparency', 'Unfold', 'VerticalGrow', 'Wave', 'Wedge', 'Wheel', 'Whip', 'Wipe', 'Magnify', 'Zoom', 'OLEObjectShow', 'OLEObjectEdit', 'OLEObjectOpen'])
  return false unless type_validator.valid?(@type)
  subtype_validator = EnumAttributeValidator.new('String', ['None', 'Across', 'Bottom', 'BottomLeft', 'BottomRight', 'Center', 'Clockwise', 'CounterClockwise', 'GradualAndCycleClockwise', 'GradualAndCycleCounterClockwise', 'Down', 'DownLeft', 'DownRight', 'FontAllCaps', 'FontBold', 'FontItalic', 'FontShadow', 'FontStrikethrough', 'FontUnderline', 'Gradual', 'Horizontal', 'HorizontalIn', 'HorizontalOut', 'In', 'InBottom', 'InCenter', 'InSlightly', 'Instant', 'Left', 'OrdinalMask', 'Out', 'OutBottom', 'OutCenter', 'OutSlightly', 'Right', 'Slightly', 'Top', 'TopLeft', 'TopRight', 'Up', 'UpLeft', 'UpRight', 'Vertical', 'VerticalIn', 'VerticalOut', 'Wheel1', 'Wheel2', 'Wheel3', 'Wheel4', 'Wheel8'])
  return false unless subtype_validator.valid?(@subtype)
  preset_class_type_validator = EnumAttributeValidator.new('String', ['Entrance', 'Exit', 'Emphasis', 'Path', 'MediaCall', 'OLEActionVerbs'])
  return false unless preset_class_type_validator.valid?(@preset_class_type)
  animate_text_type_validator = EnumAttributeValidator.new('String', ['AllAtOnce', 'ByWord', 'ByLetter'])
  return false unless animate_text_type_validator.valid?(@animate_text_type)
  return false if @shape_index.nil?
  trigger_type_validator = EnumAttributeValidator.new('String', ['AfterPrevious', 'OnClick', 'WithPrevious'])
  return false unless trigger_type_validator.valid?(@trigger_type)
  restart_validator = EnumAttributeValidator.new('String', ['Always', 'WhenNotActive', 'Never', 'NotDefined'])
  return false unless restart_validator.valid?(@restart)
  after_animation_type_validator = EnumAttributeValidator.new('String', ['DoNotDim', 'Color', 'HideAfterAnimation', 'HideOnNextMouseClick'])
  return false unless after_animation_type_validator.valid?(@after_animation_type)
  true
end