CanvasTween Class

A component for animating the alpha of a CanvasGroup, useful for UI fading

Inheritance Hierarchy

SystemObject
  UnityEngine.Object
    UnityEngine.Component
      UnityEngine.Behaviour
        UnityEngine.MonoBehaviour
          ImmerseSDKCanvasTween

Namespace: ImmerseSDK
Assembly: ImmerseSDK.App (in ImmerseSDK.App.dll) Version: 3.9.0.0 (3.9.0.0)

Syntax

Copy

[HelpURLAttribute("https://immerse.readme.io/")]
[UnityEngine.RequireComponent(typeof(UnityEngine.CanvasGroup))]
public sealed class CanvasTween : UnityEngine.MonoBehaviour

The CanvasTween type exposes the following members.

Constructors

	Name	Description
	CanvasTween	Initializes a new instance of the CanvasTween class

Top

Properties

	Name	Description
	IsVisible	Returns true if the alpha value of the CanvasGroup is greater than 0

Top

Methods

	Name	Description
	GetAlpha	Get the current alpha value of the attached CanvasGroup
	Hide	Hide canvas, use TransitionTime setting
	Hide(Single)	Hide canvas, override TransitionTime setting
	SetAlpha	Stop any current transition and set to a CanvasGroup alpha to a specific value
	Show	Show canvas, use TransitionTime setting
	Show(Single)	Show canvas, override TransitionTime setting
	StopTransition	Stop any current transition

Top

Events

	Name	Description
	OnVisibilityChanged	Fired when the canvas becomes visible in invisible

Top

Fields

	Name	Description
	ToggleGameObject	Should the GameObject be disabled when reaching 0 alpha (an re-enabled when showing)
	TransitionTime	The amount of time it takes to fade in/out

Top

Extension Methods

	Name	Description
	GetCopyOf	Copies all properties of a component from source to target. Uses reflection to set properties. (Defined by ComponentExtensions.)
	WaitForT	Waits for a singleton on a coroutine (Defined by SingletonManager.)

Top

Reference

ImmerseSDK Namespace