@rendley/sdk - v1.12.6
    Preparing search index...

    Class ShapeStyle

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Methods

    destroy getAlpha getAnimationAlphaMultiplier getAnimationPositionOffset getAnimationRotationOffset getAnimationScaleMultiplier getCornerRadius getCornerRadiusRelative getCrop getFillColor getHasFill getHeight getInnerRadius getNrPoints getOuterRadius getPosition getRawHeight getRawSize getRawWidth getRectRadius getRotation getScale getShape getSize getStrokeAlignment getStrokeAlpha getStrokeColor getStrokeWidth getWidth getZIndex invalidateCache load positionToCenter replaceMediaDataId scaleDownToFit serialize setAlpha setAnimationAlphaMultiplier setAnimationPositionOffset setAnimationRotationOffset setAnimationScaleMultiplier setCornerRadius setCrop setFillColor setHasFill setHeight setInnerRadius setNrPoints setOuterRadius setPosition setRectRadius setRotation setScale setShape setSize setStrokeAlpha setStrokeColor setStrokeWidth setWidth setZIndex update deserialize

    Constructors

    Methods

    • Returns the current crop values of the clip. The returned array contains four numbers: [left, top, right, bottom]

      Returns number[]

      The current crop values of the clip.

    • Returns string

    • Returns boolean

    • Returns number

    • Returns number

    • Returns number

    • Returns number

    • Returns [number, number]

    • Returns [number, number]

    • Returns number

    • Returns number

    • Returns string

    • Returns number

    • Parameters

      • sprite: ShapeSprite

      Returns void

    • Returns {
          alpha: number;
          clipId: string;
          cornerRadius?: [number, number, number, number];
          crop: [number, number, number, number];
          fillColor?: string;
          hasFill: boolean;
          height?: number;
          innerRadius?: number;
          mediaDataId?: string;
          nrPoints?: number;
          outerRadius?: number;
          position: [number, number];
          rectRadius?: number;
          relativeCornerRadius: boolean;
          rotation: number;
          scale: [number, number];
          shape: ShapeTypeEnum;
          strokeAlignment?: number;
          strokeAlpha?: number;
          strokeColor?: string;
          strokeWidth?: number;
          width?: number;
          zIndex: number;
      }

    • Parameters

      • alpha: number

      Returns void

    • Parameters

      • multiplierX: number
      • multiplierY: number

      Returns void

    • Parameters

      • radii: number | [number, number, number, number]
      • relative: boolean = false

      Returns void

    • Sets the crop values for the clip's sprite. This will clip the original texture to the given coordinates. If the sprite is not a video, gif or image, it will not be updated. If the sprite has no texture, or the texture is not valid, it will not be updated. If updatePosition is true, it will also update the position of the sprite, so that the cropped area will maintain it's visual position.

      Parameters

      • left: number

        The left coordinate of the crop area

      • top: number

        The top coordinate of the crop area

      • right: number

        The right coordinate of the crop area

      • bottom: number

        The bottom coordinate of the crop area

      • updatePosition: boolean = true

        If true, it will also update the position of the sprite, so that the middle of the cropped area is at the same position as the middle of the original texture. Default is true.

      Returns void

    • Parameters

      • fillColor: string

      Returns void

    • Parameters

      • hasFill: boolean

      Returns void

    • Parameters

      • height: number

      Returns void

    • Parameters

      • innerRadius: number

      Returns void

    • Parameters

      • nrPoints: number

      Returns void

    • Parameters

      • outerRadius: number

      Returns void

    • Parameters

      • x: number
      • y: number

      Returns void

    • Parameters

      • rectRadius: number

      Returns void

    • Parameters

      • rotation: number

      Returns void

    • Parameters

      • scaleX: number
      • scaleY: number

      Returns void

    • Parameters

      • width: number
      • height: number

      Returns void

    • Parameters

      • strokeAlpha: number

      Returns void

    • Parameters

      • strokeColor: string

      Returns void

    • Parameters

      • strokeWidth: number

      Returns void

    • Parameters

      • width: number

      Returns void

    • Parameters

      • zIndex: number

      Returns void

    • Parameters

      • container: ShapeSprite
      • redraw: boolean = false

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    destroygetAlphagetAnimationAlphaMultipliergetAnimationPositionOffsetgetAnimationRotationOffsetgetAnimationScaleMultipliergetCornerRadiusgetCornerRadiusRelativegetCropgetFillColorgetHasFillgetHeightgetInnerRadiusgetNrPointsgetOuterRadiusgetPositiongetRawHeightgetRawSizegetRawWidthgetRectRadiusgetRotationgetScalegetShapegetSizegetStrokeAlignmentgetStrokeAlphagetStrokeColorgetStrokeWidthgetWidthgetZIndexinvalidateCacheloadpositionToCenterreplaceMediaDataIdscaleDownToFitserializesetAlphasetAnimationAlphaMultipliersetAnimationPositionOffsetsetAnimationRotationOffsetsetAnimationScaleMultipliersetCornerRadiussetCropsetFillColorsetHasFillsetHeightsetInnerRadiussetNrPointssetOuterRadiussetPositionsetRectRadiussetRotationsetScalesetShapesetSizesetStrokeAlphasetStrokeColorsetStrokeWidthsetWidthsetZIndexupdatedeserialize