Version: 5.3 (switch to 5.4b)
言語English
  • C#
  • JS

スクリプト言語

好きな言語を選択してください。選択した言語でスクリプトコードが表示されます。

Graphic

class in UnityEngine.UI

/

継承:EventSystems.UIBehaviour


実装インターフェース:ICanvasElement

フィードバック

ありがとうございます

この度はドキュメントの品質向上のためにご意見・ご要望をお寄せいただき、誠にありがとうございます。頂いた内容をドキュメントチームで確認し、必要に応じて修正を致します。

閉じる

送信に失敗しました

なんらかのエラーが発生したため送信が出来ませんでした。しばらく経ってから<a>もう一度送信</a>してください。ドキュメントの品質向上のために時間を割いて頂き誠にありがとうございます。

閉じる

キャンセル

マニュアルに切り替える

説明

すべてのビジュアル UI コンポーネントのための基本クラスです

ビジュアル UI コンポーネントを作成したときこのクラスを継承する必要があります。 以下は色の付いた quad を RectTransform エリア内に描写する簡単な例です。

using UnityEngine;
using UnityEngine.UI;
using System.Collections.Generic;

[ExecuteInEditMode] public class SimpleImage : Graphic {

protected override void OnFillVBO (List<UIVertex> vbo) { Vector2 corner1 = Vector2.zero; Vector2 corner2 = Vector2.zero;

corner1.x = 0f; corner1.y = 0f; corner2.x = 1f; corner2.y = 1f;

corner1.x -= rectTransform.pivot.x; corner1.y -= rectTransform.pivot.y; corner2.x -= rectTransform.pivot.x; corner2.y -= rectTransform.pivot.y; corner1.x *= rectTransform.rect.width; corner1.y *= rectTransform.rect.height; corner2.x *= rectTransform.rect.width; corner2.y *= rectTransform.rect.height;

vbo.Clear();

UIVertex vert = UIVertex.simpleVert;

vert.position = new Vector2(corner1.x, corner1.y); vert.color = color; vbo.Add(vert); vert.position = new Vector2(corner1.x, corner2.y); vert.color = color; vbo.Add(vert); vert.position = new Vector2(corner2.x, corner2.y); vert.color = color; vbo.Add(vert); vert.position = new Vector2(corner2.x, corner1.y); vert.color = color; vbo.Add(vert); } }

Static 変数

defaultGraphicMaterial明示的にマテリアルが指定されていない場合に、UI 要素の描画のためにデフォルトマテリアルが使用されます

変数

canvasCanvas への参照。この Graphic はこの変数の Canvas にレンダリングしています
canvasRendererこの Graphic で使用される CanvasRenderer
colorGraphic の基本カラー
defaultMaterialグラフィックのためのデフォルトマテリアルを返します
depth階層のグラフィックの深度の絶対値は、レンダリングやイベントに使用されます
mainTextureグラフォックのテクスチャ(読み取り専用)
materialユーザーによって設定された Material
materialForRenderingレンダリングのために送られるマテリアル(読み取り専用)
raycastTargetこのグラフィックが Raycast のターゲットを考慮すべきかどうか
rectTransformGraphic に使用される RectTransform コンポーネント

Public 関数

CrossFadeAlphaこの Graphic に関連付けられている CanvasRenderer のカラーのアルファをトゥイーンします
CrossFadeColorこの Graphic に関連付けられている CanvasRenderer のカラーをトゥイーンします
GetPixelAdjustedRectGraphic の RectTransform にもっとも近いピクセルパーフェクトの Rect を返します
GraphicUpdateComplete ICanvasElement.GraphicUpdateComplete を参照してください。
LayoutComplete ICanvasElement.LayoutComplete を参照してください。
OnDisable MonoBehaviour.OnDisable を参照する
OnRebuildRequested Graphicのリビルドが必須の場合、Unity によって発行されるエディター専用のコールバックです。
PixelAdjustPoint渡したピクセルをピクセルパーフェクトに調整します
Raycast GraphicRaycaster がシーンにレイキャスティングしているとき、2 つのことを行っています。まず RectTransform の矩形を使用して要素をフィルタリングし、そして Raycast 関数を利用してレイキャストが要素にヒットしているかを判定します。
Rebuildグラフィックジオメトリと PreRender サイクル上のマテリアルをリビルドします
RegisterDirtyLayoutCallbackグラフィック レイアウトがダーティになったときに通知されるリスナーを追加します
RegisterDirtyMaterialCallbackグラフィック マテリアルがダーティになったときに通知されるリスナーを追加します
RegisterDirtyVerticesCallbackグラフィック頂点がダーティになったときに通知されるリスナーを追加します
SetAllDirtyダーティとして Graphic をマークします
SetLayoutDirtyダーティとしてレイアウトをマークします
SetMaterialDirtyダーティとして Material をマークします
SetNativeSizeピクセルパーフェクトにするためにグラフィックサイズを調整します
SetVerticesDirty頂点のダーティをマークします
UnregisterDirtyLayoutCallbackグラフィックレイアウトがダーティになったときに受信する通知からリスナーを削除します
UnregisterDirtyMaterialCallbackグラフィックマテリアルがダーティになったときに受信する通知からリスナーを削除します
UnregisterDirtyVerticesCallbackグラフィック頂点がダーティになったときに受信する通知からリスナーを削除します
UpdateGeometry CanvasRenderer上にあるGraphicのジオメトリを更新するために呼び出します。
UpdateMaterial CanvasRenderer上にあるグラフィックのMaterialを更新するために呼び出します。

Protected 関数

OnDisable MonoBehaviour.OnDisable を参照する
UpdateGeometry CanvasRenderer上にあるGraphicのジオメトリを更新するために呼び出します。
UpdateMaterial CanvasRenderer上にあるグラフィックのMaterialを更新するために呼び出します。

継承メンバー

変数

enabled有効であれば更新され、無効であれば更新されません。
isActiveAndEnabledBehaviour が有効かどうか
gameObjectこのコンポーネントはゲームオブジェクトにアタッチされます。コンポーネントはいつもゲームオブジェクトにアタッチされています。
tagゲームオブジェクトのタグ
transform GameObject にアタッチされた Transform (アタッチされていない場合は null)
useGUILayoutこれを無効にすると、GUI のレイアウトフェーズをスキップすることができます
hideFlagsオブジェクトは非表示、シーンに保存、ユーザーが編集可能、などを設定する。
nameオブジェクト名

Public 関数

BroadcastMessageゲームオブジェクトまたは子オブジェクトにあるすべての MonoBehaviour を継承したクラスにある methodName 名のメソッドを呼び出します。
CompareTagこのゲームオブジェクトは tag とタグ付けされているかどうか
GetComponentゲームオブジェクトに type がアタッチされている場合は type のタイプを使用してコンポーネントを返します。ない場合は null です
GetComponentInChildren GameObject や深さ優先探索を活用して、親子関係にある子オブジェクトから type のタイプのコンポーネントを取得します。
GetComponentInParent GameObject や深さ優先探索を活用して、親子関係にある親オブジェクトから type のタイプのコンポーネントを取得します。
GetComponents GameObject から type のタイプのコンポーネントを「すべて」取得します。
GetComponentsInChildren GameObject や深さ優先探索を活用して、親子関係にある子オブジェクトから type のタイプのコンポーネントを「すべて」取得します。
GetComponentsInParent GameObject や深さ優先探索を活用して、親子関係にある親オブジェクトから type のタイプのコンポーネントを「すべて」取得します。
SendMessageゲームオブジェクトにアタッチされているすべての MonoBehaviour にある methodName と名付けたメソッドを呼び出します
SendMessageUpwardsゲームオブジェクトと親(の親、さらに親 ... )にアタッチされているすべての MonoBehaviour にある methodName と名付けたメソッドを呼び出します
CancelInvokeすべての Invoke をキャンセルします
Invoke設定した時間(単位は秒)にメソッドを呼び出します
InvokeRepeating設定した時間(単位は秒)にメソッドを呼び出し、repeatRate 秒ごとにリピートします
IsInvokingメソッドの呼出が保留中かどうか
StartCoroutineコルーチンを開始します
StopAllCoroutinesBehaviour 上で実行されているコルーチンをすべて停止します
StopCoroutineこの Behaviour 上で実行されている methodName という名のコルーチン、または routine として保持されているコルーチンをすべて停止します
GetInstanceIDオブジェクトのインスタンス ID を返します
ToStringゲームオブジェクトの名前を返します
Awake MonoBehaviour.Awake を参照してください
IsActive GameObject と Component がアクティブになっている場合は true を返します。
IsDestroyedネイティブ表示の振る舞いが破棄された場合は true を返します。
OnBeforeTransformParentChangedMonoBehaviour.OnBeforeTransformParentChanged を参照してください
OnCanvasGroupChangedMonoBehaviour.OnCanvasGroupChanged を参照してください
OnCanvasHierarchyChanged親の Canvas の状態が変更されたとき呼び出されます。
OnDestroy MonoBehaviour.OnDestroy を参照してください
OnDidApplyAnimationProperties LayoutGroup.OnDidApplyAnimationProperties を参照してください
OnEnable MonoBehaviour.OnEnable を参照してください
OnRectTransformDimensionsChange関連する RectTransform の寸法が変わると、このコールバックは呼び出されます。この呼び出しは、たとえ子のトランスフォーム自体変化がなくとも、あたかも変化があったようにすべての子矩形のトランスフォームにも行われます。
OnTransformParentChangedMonoBehaviour.OnRectTransformParentChanged を参照してください
OnValidate MonoBehaviour.OnValidate を参照してください
Reset MonoBehaviour.Reset を参照してください
Start MonoBehaviour.Start を参照してください

Protected 関数

Awake MonoBehaviour.Awake を参照してください
OnBeforeTransformParentChangedMonoBehaviour.OnBeforeTransformParentChanged を参照してください
OnCanvasGroupChangedMonoBehaviour.OnCanvasGroupChanged を参照してください
OnCanvasHierarchyChanged親の Canvas の状態が変更されたとき呼び出されます。
OnDestroy MonoBehaviour.OnDestroy を参照してください
OnDidApplyAnimationProperties LayoutGroup.OnDidApplyAnimationProperties を参照してください
OnEnable MonoBehaviour.OnEnable を参照してください
OnRectTransformDimensionsChange関連する RectTransform の寸法が変わると、このコールバックは呼び出されます。この呼び出しは、たとえ子のトランスフォーム自体変化がなくとも、あたかも変化があったようにすべての子矩形のトランスフォームにも行われます。
OnTransformParentChangedMonoBehaviour.OnRectTransformParentChanged を参照してください
OnValidate MonoBehaviour.OnValidate を参照してください
Reset MonoBehaviour.Reset を参照してください
Start MonoBehaviour.Start を参照してください

Static 関数

printUnity コンソールにログを出力します (Debug.Log と同じです)
Destroyゲームオブジェクトやコンポーネント、アセットを削除します
DestroyImmediate直ちにオブジェクトを破壊する (Destroy 関数の方を使うことを推奨します)
DontDestroyOnLoad新しいシーンを読み込んでもオブジェクトが自動で破壊されないように設定します
FindObjectOfTypeタイプ type から最初に見つけたアクティブのオブジェクトを返します
FindObjectsOfTypeタイプから見つけたすべてのアクティブのオブジェクト配列を返します
Instantiateオブジェクト original のコピーを返します

Operator

boolオブジェクトが存在するかどうか
operator !=二つのオブジェクトが異なるオブジェクトを参照しているか比較します
operator ==2つのオブジェクト参照が同じオブジェクトを参照しているか比較します。

メッセージ

Awakeスクリプトのインスタンスがロードされたときに呼び出されます
FixedUpdateMonoBehaviour が有効の場合、この関数は毎回、固定フレームレートで呼び出されます。
LateUpdate Behaviour が有効の場合、LateUpdate は毎フレーム呼びだされます
OnAnimatorIKアニメーション IK (インバースキネマティクス)をセットアップするときのコールバック
OnAnimatorMoveルートモーションを修正するアニメーション動作を処理するコールバック
OnApplicationFocusプレイヤーの取得またはフォーカスを失ったときにすべてのゲームオブジェクトに送信されます。
OnApplicationPauseプレイヤーが一時停止したときにすべてのゲームオブジェクトに送信されます
OnApplicationQuitアプリケーションが終了する前にすべてのゲームオブジェクトで呼び出されます
OnAudioFilterReadOnAudioFilterRead が実装されている場合、Unity は DSP チェーンにカスタムフィルターを挿入します。
OnBecameInvisibleOnBecameInvisible はレンダラーがカメラから見えなくなったときに呼び出されます
OnBecameVisibleOnBecameVisible はレンダラーが任意のカメラから見えるようになると呼び出されます
OnCollisionEnterOnCollisionEnter はコライダー/Rigidbody が他のコライダー/Rigidbody に触れたときに呼び出されます
OnCollisionEnter2Dこのオブジェクトのコライダーに他のコライダーが接触したときに送信されます(2D Physics のみ)
OnCollisionExitOnCollisionExit はコライダー/Rigidbody と他のコライダー/Rigidbody の接触が終了したときに呼び出されます
OnCollisionExit2Dこのオブジェクトのコライダーと他のコライダーの接触が終わったときに送信されます(2D Physics のみ)
OnCollisionStayOnCollisionStay はコライダー/Rigidbody と他のコライダー/Rigidbody が接触し続けて毎フレームに一度呼び出されます
OnCollisionStay2Dこのオブジェクトのコライダーに他のコライダーが接触し続けている毎フレームの間、送信されます(2D Physics のみ)
OnConnectedToServerサーバーとの接続に成功したときにクライアント上で呼び出されます
OnControllerColliderHitOnControllerColliderHit は移動中にコントローラーがコライダーにヒットしたときに呼び出されます
OnDestroyこの関数は MonoBehaviour が破棄されるときに呼び出されます
OnDisconnectedFromServerサーバーとの接続が失われたか切断されたときにクライアント上で呼び出されます
OnDrawGizmos選択可能にしたり、常に描画したいギズモを描画するには OnDrawGizmos を使用します
OnDrawGizmosSelected選択しているオブジェクトのみのギズモを描画したい場合は OnDrawGizmosSelected を使用します
OnEnableこの関数はオブジェクトが有効/アクティブになったときに呼び出されます
OnFailedToConnect接続試行がなんらかの理由で失敗したときにクライアント上で呼び出されます
OnFailedToConnectToMasterServerMasterServer への接続に問題がある場合に、クライアントまたはサーバーで呼び出されます
OnGUIOnGUI はレンダリングと GUI イベントのハンドリングのために呼び出されます
OnJointBreakゲームオブジェクトのジョイントが壊れたときに呼び出されます
OnJointBreak2Dゲームオブジェクトにアタッチされた Joint2D が壊れたときに呼び出されます
OnLevelWasLoadedこの関数は新しいレベルがロードされた後に呼び出されます
OnMasterServerEventMasterServer からイベントを報告してくるときにクライアントまたはサーバー上で呼び出されます
OnMouseDownOnMouseDown は GUIElement または Collider 上でユーザーがマウスボタンをクリックしたときに呼び出されます
OnMouseDragOnMouseDrag はユーザーが GUIElement または Collider をマウスでクリックし、ドラッグしている間呼び出されます。
OnMouseEnterOnMouseEnter は GUIElement または Collider 上にマウスが乗ったときに呼び出されます
OnMouseExitOnMouseExit は GUIElement または Collider 上からマウス離れたときに呼び出されます
OnMouseOverOnMouseOver は GUIElement または Collider 上にマウスがあり続ける限り毎フレーム呼び出され続けます
OnMouseUpOnMouseUp はユーザーがマウスボタンを離したときに呼び出されます
OnMouseUpAsButtonOnMouseUpAsButton はマウスを押した時と同じ GUIElement や Collider 上でマウスを離した時のみに呼び出されます。
OnNetworkInstantiateNetwork.Instantiate でインスタンス化されたオブジェクトに対して呼び出されます
OnParticleCollisionOnParticleCollision はパーティクルがコライダーにヒットしたときに呼び出されます
OnPlayerConnected新しいプレイヤーが接続に成功したときにサーバー上で呼び出されます
OnPlayerDisconnectedプレイヤーがサーバーから接続が切断されるたびにサーバー上で呼び出されます
OnPostRenderOnPostRender はカメラがシーンのレンダリングを完了した後に呼び出されます
OnPreCullOnPreCull はカメラがシーンをカリングする前に呼び出されます
OnPreRenderOnPreRender はカメラがシーンのレンダリングを始める前に呼び出されます
OnRenderImageOnRenderImage はすべてのレンダリングが完了し RenterTexture にレンダリングされた後に呼び出されます
OnRenderObjectOnRenderObject はカメラがシーンのレンダリングを行った後に呼び出されます
OnSerializeNetworkViewネットワークビューによって監視されるスクリプトの変数の同期をカスタマイズするために使用します
OnServerInitializedNetwork.InitializeServer が実行され完了したときにサーバー上で呼び出されます
OnTransformChildrenChangedこの関数は GameObject の Transform のすべての子の中で変更があったときに呼び出されます
OnTransformParentChangedこの関数は GameObject の Transform の parent プロパティーに変更があったときに呼び出されます
OnTriggerEnterOnTriggerEnter は Collider が他のトリガーに入ったときに呼び出されます
OnTriggerEnter2Dトリガーコライダーをアタッチしたオブジェクトが他のオブジェクトに接触したときに送信されます(2D Physics のみ)
OnTriggerExitOnTriggerExit は Collider が他のトリガーから出たときに呼び出されます
OnTriggerExit2Dトリガーコライダーをアタッチしたオブジェクトが他のオブジェクトと接触が終わったときに送信されます(2D Physics のみ)
OnTriggerStayOnTriggerStay は Collider が他のトリガーと当たり続けている毎フレーム呼び出されます
OnTriggerStay2Dトリガーコライダーをアタッチしたオブジェクトが他のオブジェクトと接触し続けている時に毎フレーム送信されます(2D Physics のみ)
OnValidateこの関数はスクリプトがロードされた時やインスペクターの値が変更されたときに呼び出されます(この呼出はエディター上のみ)
OnWillRenderObjectOnWillRenderObject はオブジェクトが表示されている場合カメラごとに 1 度呼び出されます
Resetデフォルト値にリセットします
StartStart はスクリプトが有効で、Update メソッドが最初に呼び出される前のフレームで呼び出されます
UpdateUpdate は MonoBehaviour が有効の場合に、毎フレーム呼び出されます