new PhotoEditorSDK.Operations.SpriteOperation(sdk, options)
sdk/operations/sprite-operation.js, line 30
Creates a new SpriteOperation
Name | Type | Description |
---|---|---|
sdk |
PhotoEditorSDK | |
options |
Object | optional |
Extends
Classes
Members
-
staticPhotoEditorSDK.Operations.SpriteOperation.identifierString
-
A unique string that identifies this operation. Can be used to select operations.
- Default Value:
- sprite
Methods
-
addSprite(sprite)
sdk/operations/sprite-operation.js, line 160 -
Gets called when a sprite has been added
Name Type Description sprite
PhotoEditorSDK.Sprite -
createBrush(options){PhotoEditorSDK.Operations.SpriteOperation.Brush}
sdk/operations/sprite-operation.js, line 152 -
Creates a brush object and returns it
Name Type Description options
Object Returns:
Type Description PhotoEditorSDK.Operations.SpriteOperation.Brush -
createSticker(options){PhotoEditorSDK.Operations.SpriteOperation.Sticker}
sdk/operations/sprite-operation.js, line 134 -
Creates a new sticker object and returns it
Name Type Description options
Object Returns:
Type Description PhotoEditorSDK.Operations.SpriteOperation.Sticker -
createText(options){PhotoEditorSDK.Operations.SpriteOperation.Text}
sdk/operations/sprite-operation.js, line 143 -
Creates a new sticker object and returns it
Name Type Description options
Object Returns:
Type Description PhotoEditorSDK.Operations.SpriteOperation.Text -
dispose()
sdk/operations/sprite-operation.js, line 287 -
Disposes this operation
-
getSpritesAtPosition(position, inputDimensions){Array.<PhotoEditorSDK.Sprite>}
sdk/operations/sprite-operation.js, line 238 -
Returns the sprites at the given position on the canvas
Name Type Description position
PhotoEditorSDK.Math.Vector2 inputDimensions
PhotoEditorSDK.Math.Vector2 Returns:
Type Description Array.<PhotoEditorSDK.Sprite> -
getSpritesOfType(Klass){Array.<PhotoEditorSDK.Sprite>}
sdk/operations/sprite-operation.js, line 53 -
Returns the sprites that are instances of the given class
Name Type Description Klass
Class Returns:
Type Description Array.<PhotoEditorSDK.Sprite> -
removeSprite(sprite){Boolean}
sdk/operations/sprite-operation.js, line 175 -
Removes the given sprite from the list of sprites
Name Type Description sprite
PhotoEditorSDK.Sprite Returns:
Type Description Boolean -
setDirtyForRenderer(dirty, renderer, dimensionsChanged)
sdk/operations/sprite-operation.js, line 277 -
Sets the dirtiness for the given renderer
Name Type Description dirty
Boolean renderer
PhotoEditorSDK.Engine.BaseRenderer dimensionsChanged
Boolean = false
-
takeSpriteToFront(sprite)
sdk/operations/sprite-operation.js, line 218 -
Takes the given Sprite to front
Name Type Description sprite
PhotoEditorSDK.Operations.SpriteOperation.Sprite