Class CircleComponent

animationSet

animated

• get animated(): boolean

  Determines whether the node has any animation data.

  Returns boolean

collection

• get collection(): WebaniCollection<WebaniTransformable>

  The collection which this RenderedGroupNode object wraps.

  Returns WebaniCollection<WebaniTransformable>

isLeaf

• get isLeaf(): boolean

  Determines if the current node is a leaf node.

  Returns boolean

leaves

• get leaves(): RenderedGroupNode[]

  Recursively determines the leaf nodes in the tree formed by the RenderedGroupNode

  Returns RenderedGroupNode[]

done

• done(t: number): boolean

  Returns whether all animations in this node's animation set are complete at a given time.

  Parameters

  • t: number

    The current timestamp.

  Returns boolean

FadeIn

• FadeIn(
      duration?: number,
      keepInitialOpacity?: boolean,
      asynchronous?: boolean,
  ): CircleComponent

  Fades in all contained objects over a given duration.

  Parameters

  • duration: number = 1000

    Duration of the animation in milliseconds.
  • keepInitialOpacity: boolean = false

    If true, respects original opacity before fading in.
  • asynchronous: boolean = false

    If true, the animation is asynchronous

  Returns CircleComponent

FadeOut

• FadeOut(duration?: number, asynchronous?: boolean): CircleComponent

  Fades out all contained objects over a given duration.

  Parameters

  • duration: number = 1000

    Duration of the animation in milliseconds.
  • asynchronous: boolean = false

    If true, the animation is asynchronous

  Returns CircleComponent

frame

• frame(t: number): WebaniTransformable

  Returns the WebaniCollection frame at the given time.

  Parameters

  • t: number

    The time in milliseconds

  Returns WebaniTransformable

Hide

• Hide(): void

  Immediately hides the entire RenderedGroupNode. No animations are queued.

  Returns void

Move

• Move(
      offset: Vector3,
      duration?: number,
      asynchronous?: boolean,
  ): CircleComponent

  Moves the node by a specified offset (i.e. a translation).

  Parameters

  • offset: Vector3
  • duration: number = 1000

    Duration of the animation.
  • asynchronous: boolean = false

    If true, the animation is asynchronous.

  Returns CircleComponent

onAnimationAdded

• onAnimationAdded(
      handler: (
          animation: WebaniCollectionAnimation,
          asynchronous: boolean,
      ) => void,
  ): void

  Registers a callback to be invoked whenever a new animation is added.

  Parameters

  • handler: (animation: WebaniCollectionAnimation, asynchronous: boolean) => void

    Callback receiving the newly added animation and whether it is asynchronous.

  Returns void

OverridePosition

• OverridePosition(position: Vector3): CircleComponent

  Immediately sets the position of the entire RenderedGroupNode. No animations are queued.

  Parameters

  • position: Vector3

  Returns CircleComponent

OverrideRotation

• OverrideRotation(rotation: Vector3, center?: Vector3): CircleComponent

  Immediately sets the rotation of the entire RenderedGroupNode. No animations are queued.

  Parameters

  • rotation: Vector3
  • Optionalcenter: Vector3

  Returns CircleComponent

Rotate

• Rotate(
      rotation: Vector3,
      duration?: number,
      center?: Vector3,
      asynchronous?: boolean,
  ): CircleComponent

  Rotates the group by a specified rotation.

  Parameters

  • rotation: Vector3

    The rotation to perform.
  • duration: number = 1000

    Duration of the animation.
  • Optionalcenter: Vector3

    Optional center for the rotation. The default is the center of the contained WebaniCollection
  • asynchronous: boolean = false

    If true, the animation is asynchronous.

  Returns CircleComponent

Scale

• Scale(
      factor: Vector3,
      duration?: number,
      asynchronous?: boolean,
      backwards?: boolean,
  ): CircleComponent

  Scales all objects in the group by the given factor.

  Parameters

  • factor: Vector3

    The scale factor on each axis.
  • duration: number = 1000

    Duration of the animation.
  • asynchronous: boolean = false

    If true, the animation is asynchronous.
  • backwards: boolean = false

    If true, the animation plays in reverse.

  Returns CircleComponent

SetColor

• SetColor(
      newColor: Vector3,
      duration?: number,
      asynchronous?: boolean,
  ): CircleComponent

  Animates an interpolated change of color for all WebaniPrimitiveObjects in the node with the provided duration

  Parameters

  • newColor: Vector3

    RGB values of the new color.
  • duration: number = 1000

    Duration of the transition animation.
  • asynchronous: boolean = false

    If true, the animation is asynchronous.

  Returns CircleComponent

SetPosition

• SetPosition(
      position: Vector3,
      duration?: number,
      asynchronous?: boolean,
  ): CircleComponent

  Moves the node to a specific position.

  Parameters

  • position: Vector3
  • duration: number = 1000

    Duration of the animation.
  • asynchronous: boolean = false

    If true, the animation is asynchronous.

  Returns CircleComponent

SetRotation

• SetRotation(
      rotation: Vector3,
      duration?: number,
      center?: Vector3,
      asynchronous?: boolean,
  ): CircleComponent

  Rotates the node to a specific rotation.

  Parameters

  • rotation: Vector3

    The target rotation.
  • duration: number = 1000

    Duration of the animation.
  • Optionalcenter: Vector3

    Optional center for the rotation. The default is the center of the contained WebaniCollection
  • asynchronous: boolean = false

    If true, the animation is asynchronous.

  Returns CircleComponent

TransformInto

• TransformInto(
      after: RenderableObject,
      duration?: number,
      asynchronous?: boolean,
  ): CircleComponent

  Morphs this node into another RendereableObject. This is a very powerful method which can be utilized to recreate many of the other animation methods available to RenderedGroupNode objects.

  Parameters

  • after: RenderableObject

    Target object.
  • duration: number = 800

    Duration of the transformation.
  • asynchronous: boolean = false

    If true, the animation is asynchronous.

  Returns CircleComponent

Wait

• Wait(duration: number): CircleComponent

  Waits for a specified duration without modifying the object. Useful for sequencing animations.

  Parameters

  • duration: number

    Wait time in milliseconds.

  Returns CircleComponent

ZoomIn

• ZoomIn(duration?: number, asynchronous?: boolean): CircleComponent

  Performs a zoom-in effect using backwards Scale.

  Parameters

  • duration: number = 1000

    Duration of the zoom.
  • asynchronous: boolean = false

    If true, the animation is asynchronous.

  Returns CircleComponent

ZoomOut

• ZoomOut(duration?: number, asynchronous?: boolean): CircleComponent

  Performs a zoom-out effect using Scale followed by a FadeOut.

  Parameters

  • duration: number = 1000

    Duration of the zoom.
  • asynchronous: boolean = false

    If true, the animation is asynchronous.

  Returns CircleComponent

StaticCreateGroup

• CreateGroup<T extends Object>(object: T): RenderedGroup<T>

  Recursively constructs a RenderedGroupNode hierarchy from a nested object structure.

  Type Parameters

  • T extends Object

  Parameters

  • object: T

    A nested object to convert into a RenderedGroupNode.

  Returns RenderedGroup<T>

  A root RenderedGroupNode representing the object structure.

StaticGetGenerator

• GetGenerator<T extends Component>(
      this: new (...args: unknown[]) => T,
  ): (...vars: Parameters<T["objectConstructor"]>) => T

  A static method that returns a generator function for creating new instances of the Component class. Types are automatically inferred from the objectConstructor

  Type Parameters

  • T extends Component

  Parameters

  • this: new (...args: unknown[]) => T

  Returns (...vars: Parameters<T["objectConstructor"]>) => T

  A function that can be used to create instances of the Component class with specific parameters.