IItemEffect
Defined in: core/items/ieffects.ts:45
Methods
Section titled “Methods”getBorderEffectColor()
Section titled “getBorderEffectColor()”getBorderEffectColor():
Promise<Color>
Defined in: core/items/ieffects.ts:130
return: Promise
Gets the border effect color. Only relevant when mask effect is set to shape
Returns
Section titled “Returns”Promise<Color>
getBorderEffectOpacity()
Section titled “getBorderEffectOpacity()”getBorderEffectOpacity():
Promise<number>
Defined in: core/items/ieffects.ts:114
return: Promise
Gets the border effect opacity (0 - 100). Only relevant when mask effect is set to shape
Returns
Section titled “Returns”Promise<number>
getBorderEffectRadius()
Section titled “getBorderEffectRadius()”getBorderEffectRadius():
Promise<number>
Defined in: core/items/ieffects.ts:75
return: Promise
Gets the border effect radius (0 - 100), relative to the size of the source. Only relevant when mask effect is set to shape
Returns
Section titled “Returns”Promise<number>
getBorderEffectThickness()
Section titled “getBorderEffectThickness()”getBorderEffectThickness():
Promise<number>
Defined in: core/items/ieffects.ts:93
return: Promise
Gets the border effect thickness (0 - 100), relative to the size of the source. Only relevant when mask effect is set to shape
Returns
Section titled “Returns”Promise<number>
getFileMask()
Section titled “getFileMask()”getFileMask():
Promise<string>
Defined in: core/items/ieffects.ts:248
return: Promise
Determines the image used to mask the source. Only relevant when mask effect is set to file
Returns
Section titled “Returns”Promise<string>
getFilter()
Section titled “getFilter()”getFilter():
Promise<Filter>
Defined in: core/items/ieffects.ts:284
return: Promise
Gets the post processing shader used
Returns
Section titled “Returns”Promise<Filter>
getFilterConfig()
Section titled “getFilterConfig()”getFilterConfig():
Promise<Object>
Defined in: core/items/ieffects.ts:317
return: Promise
Gets the post-processing shader configurations as an object possibly having properties such as:
intensity: percentage of filter appliedresourceFile: PNG image used as a reference for LUTs
Returns
Section titled “Returns”Promise<Object>
getMaskEffect()
Section titled “getMaskEffect()”getMaskEffect():
Promise<MaskEffect>
Defined in: core/items/ieffects.ts:51
return: Promise
Determines the mask effect being used
Returns
Section titled “Returns”Promise<MaskEffect>
getShadowEffectBlur()
Section titled “getShadowEffectBlur()”getShadowEffectBlur():
Promise<number>
Defined in: core/items/ieffects.ts:168
return: Promise
Gets the shadow effect blur (0 - 100). Only relevant when mask effect is set to shape
Returns
Section titled “Returns”Promise<number>
getShadowEffectOffsetX()
Section titled “getShadowEffectOffsetX()”getShadowEffectOffsetX():
Promise<number>
Defined in: core/items/ieffects.ts:201
return: Promise
Gets the horizontal shadow effect offset (-100 to -100), relative to the size of the source. Only relevant when mask effect is set to shape
Returns
Section titled “Returns”Promise<number>
getShadowEffectOffsetY()
Section titled “getShadowEffectOffsetY()”getShadowEffectOffsetY():
Promise<number>
Defined in: core/items/ieffects.ts:224
return: Promise
Gets the vertical shadow effect offset (-100 to 100), relative to the size of the source. Only relevant when mask effect is set to shape
Returns
Section titled “Returns”Promise<number>
getShadowEffectOpacity()
Section titled “getShadowEffectOpacity()”getShadowEffectOpacity():
Promise<number>
Defined in: core/items/ieffects.ts:184
return: Promise
Gets the shadow effect opacity (0 - 100). Only relevant when mask effect is set to shape
Returns
Section titled “Returns”Promise<number>
getShadowEffectThickness()
Section titled “getShadowEffectThickness()”getShadowEffectThickness():
Promise<number>
Defined in: core/items/ieffects.ts:147
return: Promise
Gets the shadow effect thickness (0 - 100), relative to the size of the source. Only relevant when mask effect is set to shape
Returns
Section titled “Returns”Promise<number>
isFileMaskingGuideVisible()
Section titled “isFileMaskingGuideVisible()”isFileMaskingGuideVisible():
Promise<boolean>
Defined in: core/items/ieffects.ts:265
return: Promise
Check whether the file masking guide is visible or not. Only relevant when mask effect is set to file
Returns
Section titled “Returns”Promise<boolean>
removeFilter()
Section titled “removeFilter()”removeFilter():
Promise<IItemEffect>
Defined in: core/items/ieffects.ts:307
Removes the set post-processing shader used. Similar to setting to NONE
Chainable.
Returns
Section titled “Returns”Promise<IItemEffect>
setBorderEffectColor()
Section titled “setBorderEffectColor()”setBorderEffectColor(
value):Promise<IItemEffect>
Defined in: core/items/ieffects.ts:139
param: (value: Color)
Sets the border effect color. Only relevant when mask effect is set to shape
Chainable.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<IItemEffect>
setBorderEffectOpacity()
Section titled “setBorderEffectOpacity()”setBorderEffectOpacity(
value):Promise<IItemEffect>
Defined in: core/items/ieffects.ts:123
param: (value: number)
Sets the border effect opacity (0 - 100). Only relevant when mask effect is set to shape
Chainable.
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”Promise<IItemEffect>
setBorderEffectRadius()
Section titled “setBorderEffectRadius()”setBorderEffectRadius(
value):Promise<IItemEffect>
Defined in: core/items/ieffects.ts:85
param: (value: number)
Sets the border effect radius (0 - 100), relative to the size of the source. Only relevant when mask effect is set to shape
Chainable.
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”Promise<IItemEffect>
setBorderEffectThickness()
Section titled “setBorderEffectThickness()”setBorderEffectThickness(
value):Promise<IItemEffect>
Defined in: core/items/ieffects.ts:107
param: (value: number)
Sets the border effect thickness (0 - 100), relative to the size of the source. Only relevant when mask effect is set to shape
Chainable.
Note that since a source occupies its own ‘window’ in the XBC stage, it is specifically made that the edge effects are still within the boundaries of the source, such that increasing border thickness adds the layer inwards instead of outwards.
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”Promise<IItemEffect>
setFileMask()
Section titled “setFileMask()”setFileMask(
value):Promise<IItemEffect>
Defined in: core/items/ieffects.ts:258
param: (value: string)
Sets the image to be used used to mask the source. Only relevant when mask effect is set to file
Chainable.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<IItemEffect>
setFilter()
Section titled “setFilter()”setFilter(
value,config?):Promise<IItemEffect>
Defined in: core/items/ieffects.ts:293
param: (value: Filter or transitionString)
Sets the post processing shader to be used for the Item
Chainable.
Parameters
Section titled “Parameters”any
config?
Section titled “config?”intensity?
Section titled “intensity?”number
resourceFile?
Section titled “resourceFile?”string
Returns
Section titled “Returns”Promise<IItemEffect>
setMaskEffect()
Section titled “setMaskEffect()”setMaskEffect(
value):Promise<IItemEffect>
Defined in: core/items/ieffects.ts:65
param: (value: MaskEffect)
Sets the mask effect to any one of three possible choices: Shape/Edge effects, File masking (both bind to stage and bind to source), or None(mask effect disabled).
Chainable.
After setting the mask effect, you may tweak settings specific to that effect.
- None
- Shape: methods prefixed with
getBorderEffect-*,getShadowEffect-*,setBorderEffect-*, orsetShadowEffect-* - File: methods
getFileMask,setFileMask,showFileMaskingGuideandisFileMaskingGuideVisible
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<IItemEffect>
setShadowEffectBlur()
Section titled “setShadowEffectBlur()”setShadowEffectBlur(
value):Promise<IItemEffect>
Defined in: core/items/ieffects.ts:177
param: (value: number)
Sets the shadow effect blur (0 - 100). Only relevant when mask effect is set to shape
Chainable.
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”Promise<IItemEffect>
setShadowEffectOffsetX()
Section titled “setShadowEffectOffsetX()”setShadowEffectOffsetX(
value):Promise<IItemEffect>
Defined in: core/items/ieffects.ts:216
param: (value: number)
Sets the horizontal shadow effect offset (-100 to 100), relative to the size of the source. Only relevant when mask effect is set to shape
Chainable.
A positive horizontal offset shifts the shadow to the right of the horizontal center at the background, which visually seems to decrease the left portion of the shadow. A negative horizontal offset in turn shifts the shadow to the left, visually decreasing the right portion of the shadow.
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”Promise<IItemEffect>
setShadowEffectOffsetY()
Section titled “setShadowEffectOffsetY()”setShadowEffectOffsetY(
value):Promise<IItemEffect>
Defined in: core/items/ieffects.ts:239
param: (value: number)
Sets the vertical shadow effect offset (-100 to 100), relative to the size of the source. Only relevant when mask effect is set to shape
Chainable.
A positive vertical offset shifts the shadow below the vertical center at the background, which visually seems to decrease the top portion of the shadow. A negative vertical offset in turn shifts the shadow above, visually decreasing the bottom portion of the shadow.
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”Promise<IItemEffect>
setShadowEffectOpacity()
Section titled “setShadowEffectOpacity()”setShadowEffectOpacity(
value):Promise<IItemEffect>
Defined in: core/items/ieffects.ts:193
param: (value: number)
Sets the shadow effect opacity (0 - 100). Only relevant when mask effect is set to shape
Chainable.
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”Promise<IItemEffect>
setShadowEffectThickness()
Section titled “setShadowEffectThickness()”setShadowEffectThickness(
value):Promise<IItemEffect>
Defined in: core/items/ieffects.ts:161
param: (value: number)
Sets the shadow effect thickness (0 - 100), relative to the size of the source. Only relevant when mask effect is set to shape
Chainable.
Note that since a source occupies its own ‘window’ in the XBC stage, it is specifically made that the edge effects are still within the boundaries of the source, such that increasing thickness adds the layer inwards instead of outwards.
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”Promise<IItemEffect>
showFileMaskingGuide()
Section titled “showFileMaskingGuide()”showFileMaskingGuide(
value):Promise<IItemEffect>
Defined in: core/items/ieffects.ts:277
param: (value: boolean)
shows or hides the file masking guide. Only relevant when mask effect is set to file
Chainable.
The file masking guide highlights the area of the source that is currently being masked. Please note that resetting mask effect also resets this to false
Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”Promise<IItemEffect>