Shape

Exports related to SVG shapes.

interface ShapeMedia 
extends VisibleMedia {
  accountId: string
  /** True if I have transparency. */
  alpha?: boolean
  api: () => Promise<DataOrError<Api>>
  asStored: unknown
  boolean: (key: string) => boolean
  cacheMedia: (args: MediaCacheArgs) => Promise<DataOrError<number>>
  /** True if I can be a clipped container. */
  canBeContainer?: boolean
  /** True if I can be clipped content. */
  canBeContent?: boolean
  /** True if I am a fill color. */
  canBeFill?: boolean
  canBeMuted: boolean
  changeObject: (propertyId: SignalId, scalar?: Scalar) => ChangeEditObject
  changeScalars: (scalars: ScalarsById) => void
  changesObject: (scalars: ScalarsById) => ChangePropertiesEditObject
  clipObject: (object?: InstanceObject) => ClipObject
  constrainedValue: (found: Property, value?: Scalar) => Scalar | undefined
  createdAt?: number
  deletedAt?: number
  duration: number
  fetchResource: (resource: Resource) => Promise<DataOrError<true>>
  findResource: (types: Strings) => Resource | undefined
  frames: (quantize: number) => number
  hasIntrinsicSizing?: boolean
  hasIntrinsicTiming?: boolean
  host: Plugins
  id: string
  instanceArgs: (object?: InstanceObject) => InstanceArgs
  instanceFromObject: (object?: InstanceObject) => Instance
  /** True if I am vector-based. */
  isVector?: boolean
  label: string
  mediaIds: Strings
  number: (key: string) => number
  pathSize: Size
  /** Size drawn from sized resource. */
  probeSize?: Size
  properties: Array<Property>
  propertiesOfTarget: (targetId: string) => Array<Property>
  propertyFind: (name: string) => Property | undefined
  propertyIds: (targetId: string) => Array<SignalId>
  resources: Array<Resource>
  scalarsRecord: (idOrNames: Strings) => ScalarRecord
  setValue: (nameOrId: string, scalar?: Scalar, dontConstrain?: boolean) => void
  shouldSelectProperty: (property: Property) => boolean
  source: string
  string: (key: string) => string
  targetId: string
  toJSON: () => unknown
  tweenValues: (key: string, time: Time, range: TimeRange) => Array<Scalar>
  tweens: (key: string) => boolean
  type: string
  unload: () => void
  updatedAt?: number
  userId?: string
  value: (key: string) => Scalar | undefined
}

interface ShapeProperties  {
  path?: string
}

/** @implements ShapeMedia */
class ClientShapeImageClass
extends ShapeMediaClass {
  accountId: string
  /** True if I have transparency. */
  alpha?: boolean
  api: () => Promise<DataOrError<Api>>
  asStored: unknown
  boolean: (key: string) => boolean
  cacheMedia: (args: MediaCacheArgs) => Promise<DataOrError<number>>
  /** True if I can be a clipped container. */
  canBeContainer?: boolean
  /** True if I can be clipped content. */
  canBeContent?: boolean
  /** True if I am a fill color. */
  canBeFill?: boolean
  canBeMuted: boolean
  changeObject: (propertyId: SignalId, scalar?: Scalar) => ChangeEditObject
  changeScalars: (scalars: ScalarsById) => void
  changesObject: (scalars: ScalarsById) => ChangePropertiesEditObject
  clipObject: (object?: InstanceObject) => ClipObject
  constrainedValue: (found: Property, value?: Scalar) => Scalar | undefined
  createdAt?: number
  deletedAt?: number
  duration: number
  fetchResource: (resource: Resource) => Promise<DataOrError<true>>
  findResource: (types: Strings) => Resource | undefined
  frames: (quantize: number) => number
  hasIntrinsicSizing?: boolean
  hasIntrinsicTiming?: boolean
  host: Plugins
  id: string
  instanceArgs: (object?: InstanceObject) => InstanceArgs
  instanceFromObject: (object?: InstanceObject) => Instance
  /** True if I am vector-based. */
  isVector?: boolean
  label: string
  mediaIds: Strings
  number: (key: string) => number
  pathSize: Size
  /** Size drawn from sized resource. */
  probeSize?: Size
  properties: Array<Property>
  propertiesOfTarget: (targetId: string) => Array<Property>
  propertyFind: (name: string) => Property | undefined
  propertyIds: (targetId: string) => Array<SignalId>
  resources: Array<Resource>
  scalarsRecord: (idOrNames: Strings) => ScalarRecord
  setValue: (nameOrId: string, scalar?: Scalar, dontConstrain?: boolean) => void
  shouldSelectProperty: (property: Property) => boolean
  source: string
  string: (key: string) => string
  targetId: string
  toJSON: () => unknown
  tweenValues: (key: string, time: Time, range: TimeRange) => Array<Scalar>
  tweens: (key: string) => boolean
  tweensProperty: (key: string) => boolean
  type: string
  unload: () => void
  updatedAt?: number
  userId?: string
  value: (key: string) => Scalar | undefined
}

/** @implements VisibleInstance */
class ClippedClientShapeImageClass
extends VisibleInstanceClass {
  asset: Media
  assetFrames: (quantize: number) => Numbers
  assetId: string
  assetTime: (masherTime: Time) => Time
  boolean: (key: string) => boolean
  cacheInstance: (args: InstanceCacheArgs) => Promise<DataOrError<number>>
  canBeMuted: boolean
  changeObject: (propertyId: SignalId, scalar?: Scalar) => ChangeEditObject
  changeScalars: (scalars: ScalarsById) => void
  changesObject: (scalars: ScalarsById) => ChangePropertiesEditObject
  clip: Clip
  clippedElement: (content: VisibleInstance, args: ContainerSvgItemArgs) => DataOrError<SvgItemsRecord>
  constrainedValue: (found: Property, value?: Scalar) => Scalar | undefined
  containedItem: (contentItem: MaybeComplexSvgItem, containerItem: MaybeComplexSvgItem, args: ContainerSvgItemArgs) => DataOrError<SvgItemsRecord>
  containerRects: (args: ContainerRectArgs, sizingSize: Size) => RectTuple
  containerSvgItem: (args: ContainerSvgItemArgs) => DataOrError<MaybeComplexSvgItem>
  contentRect: (time: Time, containerRect: Rect, outputSize: Size) => Rect
  contentRects: (args: ContentRectArgs) => RectTuple
  contentSvgItem: (args: ContentSvgItemArgs) => DataOrError<MaybeComplexSvgItem>
  cropDirections: SideDirectionRecord
  frames: (quantize: number) => number
  hasIntrinsicTiming: boolean
  host: Plugins
  id: string
  instanceObject: InstanceObject
  intrinsicRect: Rect
  intrinsicsKnown: (options: IntrinsicOptions) => boolean
  isDefault: boolean
  mediaIds: Strings
  muted: boolean
  number: (key: string) => number
  properties: Array<Property>
  propertiesOfTarget: (targetId: string) => Array<Property>
  propertyFind: (name: string) => Property | undefined
  propertyIds: (targetId: string) => Array<SignalId>
  scalarsById: (targetId: string, time?: Time, timeIsStart?: boolean, useNames?: boolean) => SignalScalarRecord
  scalarsRecord: (idOrNames: Strings) => ScalarRecord
  scaleRects: (time: Time, range: TimeRange) => RectTuple
  setValue: (nameOrId: string, scalar?: Scalar, dontConstrain?: boolean) => void
  shouldSelectProperty: (property: Property) => boolean
  sizeKey?: SizeKey
  string: (key: string) => string
  svgVector: (rect: Rect, forecolor?: string, opacity?: Scalar) => SvgVector
  targetId: string
  toJSON: () => unknown
  tweenValues: (key: string, time: Time, range: TimeRange) => Array<Scalar>
  tweening: boolean
  tweens: (key: string) => boolean
  tweensProperty: (key: string) => boolean
  value: (key: string) => Scalar | undefined
}

/** @implements VisibleInstance */
class ClippedShapeImageClass
extends ShapeInstanceClass {
  asset: Media
  assetFrames: (quantize: number) => Numbers
  assetId: string
  assetTime: (masherTime: Time) => Time
  boolean: (key: string) => boolean
  cacheInstance: (args: InstanceCacheArgs) => Promise<DataOrError<number>>
  canBeMuted: boolean
  changeObject: (propertyId: SignalId, scalar?: Scalar) => ChangeEditObject
  changeScalars: (scalars: ScalarsById) => void
  changesObject: (scalars: ScalarsById) => ChangePropertiesEditObject
  clip: Clip
  clippedElement: (content: VisibleInstance, args: ContainerSvgItemArgs) => DataOrError<SvgItemsRecord>
  constrainedValue: (found: Property, value?: Scalar) => Scalar | undefined
  containedItem: (contentItem: MaybeComplexSvgItem, containerItem: MaybeComplexSvgItem, args: ContainerSvgItemArgs) => DataOrError<SvgItemsRecord>
  containerRects: (args: ContainerRectArgs, sizingSize: Size) => RectTuple
  containerSvgItem: (args: ContainerSvgItemArgs) => DataOrError<MaybeComplexSvgItem>
  contentRect: (time: Time, containerRect: Rect, outputSize: Size) => Rect
  contentRects: (args: ContentRectArgs) => RectTuple
  contentSvgItem: (args: ContentSvgItemArgs) => DataOrError<MaybeComplexSvgItem>
  cropDirections: SideDirectionRecord
  frames: (quantize: number) => number
  hasIntrinsicTiming: boolean
  host: Plugins
  id: string
  instanceObject: InstanceObject
  intrinsicRect: Rect
  intrinsicsKnown: (options: IntrinsicOptions) => boolean
  isDefault: boolean
  mediaIds: Strings
  muted: boolean
  number: (key: string) => number
  properties: Array<Property>
  propertiesOfTarget: (targetId: string) => Array<Property>
  propertyFind: (name: string) => Property | undefined
  propertyIds: (targetId: string) => Array<SignalId>
  scalarsById: (targetId: string, time?: Time, timeIsStart?: boolean, useNames?: boolean) => SignalScalarRecord
  scalarsRecord: (idOrNames: Strings) => ScalarRecord
  scaleRects: (time: Time, range: TimeRange) => RectTuple
  setValue: (nameOrId: string, scalar?: Scalar, dontConstrain?: boolean) => void
  shouldSelectProperty: (property: Property) => boolean
  sizeKey?: SizeKey
  string: (key: string) => string
  svgVector: (rect: Rect, forecolor?: string, opacity?: Scalar) => SvgVector
  targetId: string
  toJSON: () => unknown
  tweenValues: (key: string, time: Time, range: TimeRange) => Array<Scalar>
  tweening: boolean
  tweens: (key: string) => boolean
  tweensProperty: (key: string) => boolean
  value: (key: string) => Scalar | undefined
}

/** @implements ShapeMedia */
class ShapeImageClass
extends ShapeMediaClass {
  accountId: string
  /** True if I have transparency. */
  alpha?: boolean
  api: () => Promise<DataOrError<Api>>
  asStored: unknown
  boolean: (key: string) => boolean
  cacheMedia: (args: MediaCacheArgs) => Promise<DataOrError<number>>
  /** True if I can be a clipped container. */
  canBeContainer?: boolean
  /** True if I can be clipped content. */
  canBeContent?: boolean
  /** True if I am a fill color. */
  canBeFill?: boolean
  canBeMuted: boolean
  changeObject: (propertyId: SignalId, scalar?: Scalar) => ChangeEditObject
  changeScalars: (scalars: ScalarsById) => void
  changesObject: (scalars: ScalarsById) => ChangePropertiesEditObject
  clipObject: (object?: InstanceObject) => ClipObject
  constrainedValue: (found: Property, value?: Scalar) => Scalar | undefined
  createdAt?: number
  deletedAt?: number
  duration: number
  fetchResource: (resource: Resource) => Promise<DataOrError<true>>
  findResource: (types: Strings) => Resource | undefined
  frames: (quantize: number) => number
  hasIntrinsicSizing?: boolean
  hasIntrinsicTiming?: boolean
  host: Plugins
  id: string
  instanceArgs: (object?: InstanceObject) => InstanceArgs
  instanceFromObject: (object?: InstanceObject) => Instance
  /** True if I am vector-based. */
  isVector?: boolean
  label: string
  mediaIds: Strings
  number: (key: string) => number
  pathSize: Size
  /** Size drawn from sized resource. */
  probeSize?: Size
  properties: Array<Property>
  propertiesOfTarget: (targetId: string) => Array<Property>
  propertyFind: (name: string) => Property | undefined
  propertyIds: (targetId: string) => Array<SignalId>
  resources: Array<Resource>
  scalarsRecord: (idOrNames: Strings) => ScalarRecord
  setValue: (nameOrId: string, scalar?: Scalar, dontConstrain?: boolean) => void
  shouldSelectProperty: (property: Property) => boolean
  source: string
  string: (key: string) => string
  targetId: string
  toJSON: () => unknown
  tweenValues: (key: string, time: Time, range: TimeRange) => Array<Scalar>
  tweens: (key: string) => boolean
  tweensProperty: (key: string) => boolean
  type: string
  unload: () => void
  updatedAt?: number
  userId?: string
  value: (key: string) => Scalar | undefined
}

/** @implements VisibleInstance */
class ShapeInstanceClass
extends VisibleInstanceClass {
  asset: Media
  assetFrames: (quantize: number) => Numbers
  assetId: string
  assetTime: (masherTime: Time) => Time
  boolean: (key: string) => boolean
  cacheInstance: (args: InstanceCacheArgs) => Promise<DataOrError<number>>
  canBeMuted: boolean
  changeObject: (propertyId: SignalId, scalar?: Scalar) => ChangeEditObject
  changeScalars: (scalars: ScalarsById) => void
  changesObject: (scalars: ScalarsById) => ChangePropertiesEditObject
  clip: Clip
  clippedElement: (content: VisibleInstance, args: ContainerSvgItemArgs) => DataOrError<SvgItemsRecord>
  constrainedValue: (found: Property, value?: Scalar) => Scalar | undefined
  containedItem: (contentItem: MaybeComplexSvgItem, containerItem: MaybeComplexSvgItem, args: ContainerSvgItemArgs) => DataOrError<SvgItemsRecord>
  containerRects: (args: ContainerRectArgs, sizingSize: Size) => RectTuple
  containerSvgItem: (args: ContainerSvgItemArgs) => DataOrError<MaybeComplexSvgItem>
  contentRect: (time: Time, containerRect: Rect, outputSize: Size) => Rect
  contentRects: (args: ContentRectArgs) => RectTuple
  contentSvgItem: (args: ContentSvgItemArgs) => DataOrError<MaybeComplexSvgItem>
  cropDirections: SideDirectionRecord
  frames: (quantize: number) => number
  hasIntrinsicTiming: boolean
  host: Plugins
  id: string
  instanceObject: InstanceObject
  intrinsicRect: Rect
  intrinsicsKnown: (options: IntrinsicOptions) => boolean
  isDefault: boolean
  mediaIds: Strings
  muted: boolean
  number: (key: string) => number
  properties: Array<Property>
  propertiesOfTarget: (targetId: string) => Array<Property>
  propertyFind: (name: string) => Property | undefined
  propertyIds: (targetId: string) => Array<SignalId>
  scalarsById: (targetId: string, time?: Time, timeIsStart?: boolean, useNames?: boolean) => SignalScalarRecord
  scalarsRecord: (idOrNames: Strings) => ScalarRecord
  scaleRects: (time: Time, range: TimeRange) => RectTuple
  setValue: (nameOrId: string, scalar?: Scalar, dontConstrain?: boolean) => void
  shouldSelectProperty: (property: Property) => boolean
  sizeKey?: SizeKey
  string: (key: string) => string
  svgVector: (rect: Rect, forecolor?: string, opacity?: Scalar) => SvgVector
  targetId: string
  toJSON: () => unknown
  tweenValues: (key: string, time: Time, range: TimeRange) => Array<Scalar>
  tweening: boolean
  tweens: (key: string) => boolean
  tweensProperty: (key: string) => boolean
  value: (key: string) => Scalar | undefined
}

/**
 * Visible media generated from an SVG
 * path.
 * @implements ShapeMedia
 */
class ShapeMediaClass
extends VisibleMediaClass {
  accountId: string
  /** True if I have transparency. */
  alpha?: boolean
  api: () => Promise<DataOrError<Api>>
  asStored: unknown
  boolean: (key: string) => boolean
  cacheMedia: (args: MediaCacheArgs) => Promise<DataOrError<number>>
  /** True if I can be a clipped container. */
  canBeContainer?: boolean
  /** True if I can be clipped content. */
  canBeContent?: boolean
  /** True if I am a fill color. */
  canBeFill?: boolean
  canBeMuted: boolean
  changeObject: (propertyId: SignalId, scalar?: Scalar) => ChangeEditObject
  changeScalars: (scalars: ScalarsById) => void
  changesObject: (scalars: ScalarsById) => ChangePropertiesEditObject
  clipObject: (object?: InstanceObject) => ClipObject
  constrainedValue: (found: Property, value?: Scalar) => Scalar | undefined
  createdAt?: number
  deletedAt?: number
  duration: number
  fetchResource: (resource: Resource) => Promise<DataOrError<true>>
  findResource: (types: Strings) => Resource | undefined
  frames: (quantize: number) => number
  hasIntrinsicSizing?: boolean
  hasIntrinsicTiming?: boolean
  host: Plugins
  id: string
  instanceArgs: (object?: InstanceObject) => InstanceArgs
  instanceFromObject: (object?: InstanceObject) => Instance
  /** True if I am vector-based. */
  isVector?: boolean
  label: string
  mediaIds: Strings
  number: (key: string) => number
  pathSize: Size
  /** Size drawn from sized resource. */
  probeSize?: Size
  properties: Array<Property>
  propertiesOfTarget: (targetId: string) => Array<Property>
  propertyFind: (name: string) => Property | undefined
  propertyIds: (targetId: string) => Array<SignalId>
  resources: Array<Resource>
  scalarsRecord: (idOrNames: Strings) => ScalarRecord
  setValue: (nameOrId: string, scalar?: Scalar, dontConstrain?: boolean) => void
  shouldSelectProperty: (property: Property) => boolean
  source: string
  string: (key: string) => string
  targetId: string
  toJSON: () => unknown
  tweenValues: (key: string, time: Time, range: TimeRange) => Array<Scalar>
  tweens: (key: string) => boolean
  tweensProperty: (key: string) => boolean
  type: string
  unload: () => void
  updatedAt?: number
  userId?: string
  value: (key: string) => Scalar | undefined
}

function ShapeInstanceMixin<T = Constrained<VisibleInstance>>(
  Base: T
): Mixed<T, VisibleInstance>