Skip to content

Latest commit

 

History

History
262 lines (178 loc) · 4.35 KB

effect.rst

File metadata and controls

262 lines (178 loc) · 4.35 KB
Raw

Effect

SetTransparency

Set transparency of given object.

Example

  • Set Object Transparency
{
    "cmd": "SetTransparency", 
    "uid":"object01", 
    "trans":0.25 
}

SetColor

Set object color.

Parameters
Name Required Description
Object Reference <api-object-label> Yes Object Reference
color Yes Color in RGB，for instance, red is [255, 0, 0]
ratio No Effect ratio, range from 0 to 1

Example

  • Set Object Color
{
    "cmd": "SetColor",
     "uid":"object01",
     "color":[1,0,0],
     "ratio":0.75 
}

Fade

Fade effect.

Parameters
Name Required Default Description
Object Reference <api-object-label> Yes Object Reference
start Yes Start transparent value, range [0-1]
end Yes End transparent value, range [0-1]
time No 1 Effect duration in seconds
endAutoRelease No true if resume object status after effect end
enable No true Enable fading effect

Example

  • Fading Effect
{
    "cmd": "Fade",
    "uid":"object01",
    "start":1.0,
    "end":0.0, 
    "time":1.0, 
    "endAutoRelease":true 
}
  • Disable Effect
{
    "cmd": "Fade",
     "uid":"object01",
     "enable":false
 }

FadeIn

Fade In Effect.

Parameters
Name Required Default Description
Object Reference <api-object-label> Yes Object Reference
time Yes 1 Effect duration in seconds.

Example

{
    "cmd": "FadeIn",
    "uid":"object01",
    "time":1.0 
}

FadeOut

Fade Out Effect.

Parameters
Name Required Default Description
Object Reference <api-object-label> Yes Object Reference
time Yes 1 Effect duration in seconds.

Example

{
    "cmd": "FadeOut",
    "uid":"object01",
    "time":1.0 
}

Flash

Flash effect.

Parameters
Name Required Default Description
Object Reference <api-object-label> Yes Object Reference
start Yes Start transparent value
end Yes End transparent value
time No 1 Effect duration in seconds
endAutoRelease No true if resume object status after effect end
enable No true Enable fading effect

Example

  • Flash Effect
{
    "cmd": "Flash",
    "uid":"object01",
    "start":1.0,
    "end":0.0, 
    "time":1.0, 
    "endAutoRelease":true 
}
  • Disable Flash
{
    "cmd": "Flash",
    "uid":"object01",
    "enable":false
 }

ColorFade

ColorFade effect.

Parameters
Name Required Default Description
Object Reference <api-object-label> Yes Object Reference
color Yes Color used in effect
start Yes Color density at the start, value range [0-1]
end Yes Color density at the end, value range [0-1]
time No 1 Effect duration in seconds
endAutoRelease No true if resume object status after effect end
enable No true Enable fading effect

Example

  • Change object to red in one second
{
    "cmd": "ColorFade",
    "uid":"object01",
    "color":[1,0,0],
    "start":0.0,
    "end":1.0, 
    "time":1.0, 
    "endAutoRelease":false 
}
  • Disable Effect
{
    "cmd": "ColorFade",
    "uid":"object01",
    "enable":false
 }