特典pdfui要素の位置を設定します。アンカーからの相対座標でピボットの位置...
TRANSCRIPT
-
特典PDF
-
UIクラスリファレンスCanvas
CanvasScaler
CanvasRenderer
CanvasGroup
RectTransform
RectTransformUtility
EventSystem
StandaloneInputModule
TouchInputModule
GraphicRaycaster
PhysicsRaycaster
Physics2DRaycaster
Image
RawImage
Text
Selectable
Button
Toggle
ToggleGroup
Slider
Scrollbar
ScrollRect
InputField
-
Canvas
名前空間 : UnityEngine継承 : Behaviour参照 : 2-1-2~2-1-4、6-7-1~6-7-3
publicプロパティ
プロパティ名 機能 対応するInspectorの項目
int cachedSortingLayerValuesortingLayerIDプロパティに基づいて計算されキャッシュされた描画順序の値を返します(読み取り専用)。 -
bool isRootCanvas ルートのカンバスかどうかを返します(読み取り専用)。 -
bool overridePixelPerfecttrueにすると、ネストしたカンバスの親のpixelPerfectプロパティの設定を無視します。 -
bool overrideSortingtrueにすると、ネストしたカンバスの親の描画順序設定を無視します。 -
bool pixelPerfecttrueにすると、カンバス内のUI要素がピクセルに合うように描画されます。renderModeプロパティがScreenSpaceOverlayかScreenSpaceCameraのときのみ有効です。
Pixel Perfect
Rect pixelRect
カンバスの描画領域の矩形を返します(読み取り専用)。renderModeプロパティがScreenSpaceOverlayのときは、画面全体の矩形になります。WorldSpaceのときは、カメラのビューポートの矩形になります。
-
float planeDistance カンバスのカメラからの距離を設定します。 Plane Distance
float referencePixelsPerUnit デフォルトの1単位あたりのピクセル数を設定します。 -
RenderMode renderMode カンバスの描画モードを設定します。 Render Mode
int renderOrder カンバスが描画される順番を返します(読み取り専用)。 -
float scaleFactorカンバス上のすべてのUI要素をスケールする倍率を設定します。CanvasScaler.scaleFactorによって設定されます。 -
int sortingLayerID カンバスのソーティングレイヤーをIDで設定します。 Sorting Layer
string sortingLayerName カンバスのソーティングレイヤーを名前で設定します。 Sorting Layer
int sortingOrder ソーティングレイヤー内での描画順序を設定します。 Sort Order、Order in Layer
Camera worldCamera カンバスを描画するカメラを設定します。 Render Camera、Event Camera
staticメソッド
public static void ForceUpdateCanvases()
すべてのカンバスの内容を強制的に更新します。
通常、カンバスはフレームの終わりとレンダリングの直前に、レイアウトや要素の生成に関する計算をおこないます。
フレーム間に起こったすべての変更を確実に反映させるためです。フレーム間で更新されるレイアウトや要素に依存
するコードの前に、このメソッドを呼ぶことで確実に変更を反映させることが可能です。
public static Material GetDefaultCanvasMaterial()
カンバス上のテキスト以外の要素を描画するのに使用されるデフォルトのマテリアルを返します。
public static Material GetDefaultCanvasTextMaterial()
カンバス上のテキストを描画するのに使用されるデフォルトのマテリアルを返します。
-
CanvasScaler
名前空間 : UnityEngine.UI継承 : EventSystems.UIBehaviour参照 : 2-1-5
publicプロパティ
プロパティ名 機能 対応するInspectorの項目
float defaultSpriteDPIPixels Per Unitが referencePixelsPerUnitプロパティの値と同じスプライトに対する、1インチあたりのピクセル数を設定します。 Default Sprite DPI
float dynamicPixelsPerUnit動的に生成されるグラフィックの1単位あたりのピクセル数を設定します。 Dynamic Pixels Per Unit
float fallbackScreenDPI DPIが不明な場合に使用されるDPIの値を設定します。 Fallback Screen DPI
float matchWidthOrHeightscreenMatchModeプロパティがMatchWidthOrHeightのとき、参照解像度の幅と高さのどちらに合わせるかを設定します。 Match
CanvasScaler.Unit physicalUnit
UI要素の位置やサイズを設定する物理単位を設定します。 Physical Unit
float referencePixelsPerUnit カンバス上での基準となる1単位あたりのピクセル数を設定します。 Reference Pixels Per Unit
Vector2 referenceResolution 作成するUIの基準となる参照解像度を設定します。 Reference Resolution
float scaleFactor カンバス上のすべてのUI要素をスケールする倍率を設定します。 Scale Factor
CanvasScaler.ScreenMatchMode screenMatchMode
画面解像度と参照解像度のアスペクト比が異なるとき、カンバスをどのようにスケールするかを設定します。 Screen Match Mode
CanvasScaler.ScaleMode uiScaleMode
カンバス内のUI要素がどのようにスケールされるかを設定します。 Ui Scale Mode
protectedメソッド
protected virtual void Handle()
カンバスのスケールに関する計算をおこないます。カンバスのrenderModeプロパティやuiScaleModeプロパティ
の値に応じて、ほかのHandle~ ()メソッドを呼びます。
protected virtual void HandleConstantPhysicalSize()
uiScaleModeプロパティがConstantPhysicalSizeのとき、カンバスのスケールに関する計算をおこないます。
protected virtual void HandleConstantPixelSize()
uiScaleModeプロパティがConstantPixelSizeのとき、カンバスのスケールに関する計算をおこないます。
protected virtual void HandleScaleWithScreenSize()
uiScaleModeプロパティがScaleWithScreenSizeのとき、カンバスのスケールに関する計算をおこないます。
protected virtual void HandleWorldCanvas()
カンバスのrenderModeプロパティがWorldSpaceのとき、カンバスのスケールに関する計算をおこないます。
protected void SetReferencePixelsPerUnit(float referencePixelsPerUnit)
1単位あたりのピクセル数を設定します。カンバスのreferencePixelsPerUnitプロパティにも影響します。
-
protected void SetScaleFactor(float scaleFactor)
スケールする倍率を設定します。カンバスのscaleFactorプロパティにも影響します。
CanvasRenderer
名前空間 : UnityEngine継承 : Component参照 : 2-1-7、4-2-1、4-2-5
publicプロパティ
プロパティ名 機能 対応するInspectorの項目
int absoluteDepth ルートのカンバスからの深さを返します(読み取り専用)。 -
bool isMaskこのレンダラーにMaskコンポーネントがアタッチされている場合、trueを返します。 -
int relativeDepth 親のカンバスからの相対的な深さを返します(読み取り専用)。 -
publicメソッド
public void Clear()
頂点のキャッシュをすべて削除します。
public float GetAlpha()
レンダラーの現在のアルファを取得します。
public Color GetColor()
レンダラーの現在の色を取得します。
public Material GetMaterial()
レンダラーに割り当てられた現在のマテリアルを返します。
public void SetAlpha(float alpha)
レンダラーのアルファを設定します。このアルファは頂点のアルファ、カンバスのアルファと乗算されます。
public void SetColor(Color color)
レンダラーの色を設定します。この色は頂点の色、カンバスの色と乗算されます。
public void SetMaterial(Material material, Texture texture)
レンダラーのマテリアルを設定します。テクスチャが指定されている場合、マテリアルのMainTexに設定されている
テクスチャの代わりに使用されます。
-
public void SetVertices(UIVertex[] vertices, int size)
public void SetVertices(List vertices)
レンダラーによって描画される頂点を設定します。
CanvasGroup
名前空間 : UnityEngine継承 : Component, ICanvasRaycastFilter参照 : 2-1-8、6-2-1~6-2-3
publicプロパティ
プロパティ名 機能 対応するInspectorの項目
float alpha カンバスグループのアルファを設定します。 Alpha
bool blocksRaycastsカンバスグループに含まれるUI要素がレイキャストをブロックするかどうか(衝突判定を許可するかどうか)を設定します。 Blocks Raycasts
bool ignoreParentGroups親のカンバスグループで設定されているプロパティを無視するかどうかを設定します。 Ignore Parent Groups
bool interactableカンバスグループに含まれるUI要素が操作可能かどうかを設定します。 Interactable
RectTransform
名前空間 : UnityEngine継承 : Transform参照 : 2-2-1~2-2-4、6-3-3、6-5-4、6-6-3~6-6-4
publicプロパティ
プロパティ名 機能 対応するInspectorの項目
Vector2 anchoredPositionUI要素の位置を設定します。アンカーからの相対座標でピボットの位置の座標を示しています。アンカーが開いているときは、各アンカーハンドル間の中間点からの相対座標になります。
Pos X、Pos Y
Vector3 anchoredPosition3DUI要素の3D空間での位置を設定します。アンカーからの相対座標でピボットの位置の座標を示しています。アンカーが開いているときは、各アンカーハンドル間の中間点からの相対座標です。
Pos X、Pos Y、Pos Z
Vector2 anchorMax 右上のアンカーハンドルの位置を設定します。 Anchors Max
Vector2 anchorMin 左下のアンカーハンドルの位置を設定します。 Anchors Min
Vector2 offsetMax親のRect Transformの右上からUI要素の右上へのオフセットを設定します。アンカーが開いているときに設定可能です。 Right、Top
Vector2 offsetMin親のRect Transformの左下からUI要素の左下へのオフセットを設定します。アンカーが開いているときに設定可能です。 Left、Bottom
Vector2 pivot ピボットの位置を設定します。 Pivot
Rect rect ローカル座標系での矩形を示すRect構造体を返します(読み取り専用)。 -
Vector2 sizeDeltaUI要素の幅と高さを設定します。アンカーが閉じているときに設定可能です。 Width、Height
-
publicメソッドpublic void GetLocalCorners(Vector3[] fourCornersArray)
ローカル座標系におけるRect Transformの4隅の座標を取得します。
public void GetWorldCorners(Vector3[] fourCornersArray)
ワールド座標系におけるRect Transformの4隅の座標を取得します。
public void SetInsetAndSizeFromParentEdge(RectTransform.Edge edge, float inset, float size)
edgeで指定した辺の親要素からの距離(inset)、および、その方向のサイズ(size)を設定します。このメソッドは
anchorMin、anchorMax、anchoredPosition、sizeDeltaの各プロパティの値を変更します。
public void SetSizeWithCurrentAnchors(RectTransform.Axis axis, float size)
axisで指定した軸の方向のサイズを設定します。
RectTransformUtility
名前空間 : UnityEngine参照 : 6-4-3
staticメソッド
public static Bounds CalculateRelativeRectTransformBounds(Transform trans)
指定した要素以下のすべてのRect Transformを含む領域を示すBounds構造体を返します。返されるBounds構造
体の座標は、指定した要素におけるローカル座標系です。
public static Bounds CalculateRelativeRectTransformBounds(Transform root, Transform child)
childで指定した要素以下のすべてのRect Transformを含む領域を示すBounds構造体を返します。返される
Bounds構造体の座標は、rootで指定した要素におけるローカル座標系です。
public static void FlipLayoutAxes(RectTransform rect, bool keepPositioning, bool recursive)
Rect Transformの横方向と縦方向のサイズ、アラインメント(アンカーやピボット)を反転します。表示されている画
像や文字列の向きには影響しません。keepPositioningに trueを指定するとRect Transformのピボットを中心に、
falseを指定すると親要素の領域を基準に反転します。recursiveに trueを指定すると子要素も同様に反転します。
public static void FlipLayoutOnAxis(RectTransform rect, int axis, bool keepPositioning, bool recursive)
Rect Transformのアラインメント(アンカー、ピボット)を指定した軸(axis)について反転します。表示されている画
像や文字列の向きには影響しません。keepPositioningに trueを指定するとRect Transformのピボットを中心に、
falseを指定すると親要素の領域を基準に反転します。recursiveに trueを指定すると子要素も同様に反転します。
public static Vector2 PixelAdjustPoint(Vector2 point, Transform elementTransform, Canvas canvas)
スクリーン座標をピクセル単位の座標に変換します。
-
public static Rect PixelAdjustRect(RectTransform rectTransform, Canvas canvas)
ピクセル精度の座標系でRect Transformの矩形を示すRect構造体を返します。
public static bool RectangleContainsScreenPoint(RectTransform rect, Vector2 screenPoint, Camera cam)
Rect Transformの領域に、指定したカメラにおけるスクリーン座標の点が含まれるかどうかを返します。
public static bool ScreenPointToLocalPointInRectangle(RectTransform rect, Vector2 screenPoint, Camera
cam, out Vector2 localPoint)
指定したカメラにおけるスクリーン座標をRect Transformにおけるローカル座標に変換します。指定したスクリーン
座標をRect Transformの平面に投影できなかった場合、戻り値は falseになります。描画モードが「Screen Space
- Overlay」のカンバス上にあるRect Transformを指定する場合は、camにはnullを指定します。
public static Ray ScreenPointToRay(Camera cam, Vector2 screenPos)
指定したカメラから指定したスクリーン座標を通るレイを返します。
public static bool ScreenPointToWorldPointInRectangle(RectTransform rect, Vector2 screenPoint,
Camera cam, out Vector3 worldPoint)
指定したカメラにおけるスクリーン座標をRect Transformにおけるワールド座標に変換します。指定したスクリーン
座標をRect Transformの平面に投影できなかった場合、戻り値は falseになります。描画モードが「Screen Space
- Overlay」のカンバス上にあるRect Transformを指定する場合は、camにはnullを指定します。
public static Vector2 WorldToScreenPoint(Camera cam, Vector3 worldPoint)
ワールド座標を指定したカメラにおけるスクリーン座標に変換します。
EventSystem
名前空間 : UnityEngine.EventSystems継承 : UIBehaviour参照 : 2-3-1~2-3-3
staticプロパティ
プロパティ名 機能 対応するInspectorの項目
EventSystem current 現在のイベントシステムを返します。 -
publicプロパティ
プロパティ名 機能 対応するInspectorの項目
bool alreadySelectingゲームオブジェクトが選択状態になっている場合に trueを返します(読み取り専用)。 -
BaseInputModule currentInputModule
現在アクティブなインプットモジュールを返します(読み取り専用)。 -
-
プロパティ名 機能 対応するInspectorの項目
GameObject currentSelectedGameObject
現在選択されているゲームオブジェクトを返します(読み取り専用)。 -
GameObject firstSelectedGameObject
開始時に選択状態にするゲームオブジェクトを設定します。 First Selected
int pixelDragThreshold ドラッグを開始したとみなす移動距離をピクセル単位で設定します。 Drag Threshold
bool sendNavigationEventstrueにすると、キーボードやゲームコントローラーを操作したときに発生するナビゲーションイベントを送信します。 Send Navigation Events
publicメソッド
public bool IsPointerOverGameObject()
public bool IsPointerOverGameObject(int pointerId)
マウスカーソルやタッチポイントがイベントシステムに対応したゲームオブジェクトの上にあるかどうかを返します。
public void RaycastAll(PointerEventData eventData, List raycastResults)
すべてのレイキャスターを使って、シーンに対してレイキャストをおこないます。
public void SetSelectedGameObject(GameObject selected)
public void SetSelectedGameObject(GameObject selected, BaseEventData pointer)
ゲームオブジェクトを選択状態にします。前に選択されていたオブジェクトにはOnDeselectイベントが、新しく選
択されたオブジェクトにはOnSelectイベントが送信されます。
public void UpdateModules()
内部のインプットモジュールのリストを更新します。
StandaloneInputModule
名前空間 : UnityEngine.EventSystems継承 : PointerInputModule参照 : 2-3-4
publicプロパティ
プロパティ名 機能 対応するInspectorの項目
bool allowActivationOnMobileDevice
trueにすると、モバイルデバイスでもアクティブにすることができます。 Allow ActivationOn Mobile Device
string cancelButton キャンセルボタンに対応するインプットマネージャーの設定を指定します。 Cancel Button
string horizontalAxis 横方向の軸のボタンに対応するインプットマネージャーの設定を指定します。 Horizontal Axis
float inputActionsPerSecondキーボードやゲームコントローラーの入力を1秒間に何回受け付けるかを設定します。
Input Actions PerSecond
float repeatDelay 連続入力を受け付け始めるまでの遅延を設定します。 Repeat Delay
string submitButton 決定ボタンに対応するインプットマネージャーの設定を指定します。 Submit Button
string verticalAxis 縦方向の軸のボタンに対応するインプットマネージャーの設定を指定します。 Vertical Axis
-
publicメソッドpublic override void ActivateModule()
インプットモジュールがアクティブになったときに呼び出されます。
public override void DeactivateModule()
インプットモジュールが非アクティブになったときに呼び出されます。
public override bool IsModuleSupported()
インプットモジュールがサポートされているかどうかを返します。
public override void Process()
現在のフレームでのインプットモジュールの処理をおこないます。イベントシステムのUpdateメソッドから
UpdateModuleメソッドが呼ばれた後に呼び出されます。
public override bool ShouldActivateModule()
インプットモジュールをアクティブにすべきかどうかを返します。
public override void UpdateModule()
インプットモジュールの内部のステートを更新します。イベントシステムのUpdateメソッドが呼ばれるたびに呼び出
されます。
TouchInputModule 名前空間 : UnityEngine.EventSystems 継承 : PointerInputModule 参照 : 2-3-4 publicプロパティ
プロパティ名 機能 対応するInspectorの項目
bool allowActivationOnStandalone
trueにすると、スタンドアローン環境でもアクティブにすることができます。 Allow Activation On Standalone
publicメソッド
StandaloneInputModuleクラスと同様のメソッドが定義されています。
-
GraphicRaycaster
名前空間 : UnityEngine.UI継承 : BaseRaycaster参照 : 2-1-6
publicプロパティ
プロパティ名 機能 対応するInspectorの項目
GraphicRaycaster.BlockingObjects blockingObjects
レイキャストをブロックするオブジェクトのタイプを設定します。 Blocking Objects
Camera eventCamera レイを発生するカメラを設定します。 -
bool ignoreReversedGraphics trueにすると、反転して裏面が表示されている要素は無視されます。 Ignore Reversed Graphics
int renderOrderPriority描画の順序に基づくレイキャスターの優先度を返します(読み取り専用)。 -
int sortOrderPriorityソートの順序に基づくレイキャスターの優先度を返します(読み取り専用)。 -
publicメソッド
public void Raycast(PointerEventData eventData, List resultAppendList)
シーンに対してレイキャストをおこないます。
PhysicsRaycaster
名前空間 : UnityEngine.EventSystems継承 : BaseRaycaster参照 : 2-3-5
publicプロパティ
プロパティ名 機能 対応するInspectorの項目
int depthこのレイキャスターで使用するカメラの深度を返します(読み取り専用)。 -
Camera eventCamera このレイキャスターで使用するカメラを返します(読み取り専用)。 -
LayerMask eventMask レイキャストの許可するレイヤーマスクを設定します。
int finalEventMaskeventMaskプロパティとカメラのマスクの論理積(AND)による最終的なマスクを返します(読み取り専用)。 -
int sortOrderPriorityソートの順序に基づくレイキャスターの優先度を返します(読み取り専用)。 -
publicメソッド
public override void Raycast(PointerEventData eventData, List resultAppendList)
シーンに対してレイキャストをおこないます。
-
Physics2DRaycaster
名前空間 : UnityEngine.EventSystems継承 : PhysicsRaycaster参照 : 2-3-5
Physics2DRaycasterクラスはPhysicsRaycasterクラスを継承しているため、PhysicsRaycasterクラスと同様のプ
ロパティ、メソッドが定義されています。
Image
名前空間 : UnityEngine.UI継承 : MaskableGraphic, ICanvasRaycastFilter, ISerializationCallbackReceiver, ILayoutElement参照 : 3-1-1~3-1-5、6-4-3~6-4-4、6-5-5
publicプロパティ
プロパティ名 機能 対応するInspectorの項目
float eventAlphaThresholdイベントを通過させる最小のアルファ(ピクセルのアルファ)を設定します。デフォルトの値は1.0です。 -
float fillAmount塗りつぶしの量を設定します。typeプロパティがFilledのときのみ有効です。 Fill Amount
bool fillCentertrueにすると、スライスが設定されているスプライトのとき、スライスの中央部分も描画します。typeプロパティがSlicedかFilledのときのみ有効です。
Fill Center
bool fillClockwise塗りつぶしの方向を設定します。typeプロパティがFilledかつfillMethodプロパティがRadial90、Radial180、Radial360のいずれかのときのみ有効です。
Clockwise
Image.FillMethod fillMethod塗りつぶしの方法を設定します。typeプロパティがFilledのときのみ有効です。 Fill Method
int fillOrigin
塗りつぶしの基準点を設定します。typeプロパティがFilledのときのみ有効です。fillMethodによって値の範囲は、Image.OriginHorizontal、Image.OriginVertical、Image.Origin90、Image.Origin180、Image.Origin360のいずれかのenum値の範囲になります。
Fill Origin
bool hasBorderスプライトにスライスが設定されているかどうかを返します(読み取り専用)。 -
Texture mainTexture スプライトのテクスチャを返します(読み取り専用)。 -
Sprite overrideSprite表示をオーバーライドするスプライトを設定します。nullを設定するとspriteプロパティで設定しているスプライトを表示します。 -
float pixelsPerUnit 1単位あたりのピクセル数を返します(読み取り専用)。 -
bool preserveAspect trueにすると、スプライトの縦横比を保って表示します。 Preserve Aspect Ratio
Sprite sprite 表示するスプライトを設定します。 Source Image
Image.Type type イメージの種類を設定します。 Image Type
Camera worldCamera カンバスを描画するカメラを設定します。 Render Camera、Event Camera
-
publicメソッドpublic override void SetNativeSize()
イメージをスプライトのサイズ(ピクセル等倍)にリサイズします。
RawImage
名前空間 : UnityEngine.UI継承 : MaskableGraphic参照 : 3-4-1~3-4-2、Chapter 6コラム(P.316)
publicプロパティ
プロパティ名 機能 対応するInspectorの項目
Texture mainTexture 表示しているテクスチャを返します(読み取り専用)。 -
Texture texture 表示するテクスチャを設定します。 Texture
Rect uvRectローイメージの領域内での、テクスチャのオフセットとサイズを設定します。 UV Rect
publicメソッド
public override void SetNativeSize()
ローイメージをテクスチャのサイズ(ピクセル等倍)にリサイズします。
Text
名前空間 : UnityEngine.UI継承 : MaskableGraphic, ILayoutElement参照 : 3-5-1~3-5-3、6-6-4~6-6-5、6-7-3
publicプロパティ
プロパティ名 機能 対応するInspectorの項目
TextAnchor alignment 文字列の配置を設定します。 Alignment
TextGenerator cachedTextGenerator
テキストを生成するときに使われるTextGeneratorを返します(読み取り専用)。 -
TextGenerator cachedTextGeneratorForLayout
レイアウトを決定するときに使われるTextGeneratorを返します(読み取り専用)。 -
Material defaultMaterialテキストの描画にデフォルトで使用される静的なマテリアルを返します(読み取り専用)。 -
Font font フォントを設定します。 Font
int fontSize フォントサイズをピクセル単位で設定します。 Font Size
FontStyle fontStyle フォントのスタイルを設定します。 Font Style
HorizontalWrapMode horizontalOverflow
文字列がテキストの幅に収まらないときの折り返し方法を設定します。 Horizontal Overflow
float lineSpacing 行の間隔を設定します。 Line Spacing
-
プロパティ名 機能 対応するInspectorの項目
Texture mainTexture フォントのテクスチャを返します(読み取り専用)。 -
float pixelsPerUnit 1単位あたりのピクセル数を返します(読み取り専用)。 -
bool resizeTextForBestFittrueにすると、文字列がテキストの領域に収まるように、自動的にフォントサイズを変更して表示します。 Best Fit
int resizeTextMaxSizeresizeTextForBestFitプロパティが trueのときの最大のフォントサイズを設定します。 Max Size
int resizeTextMinSizeresizeTextForBestFitプロパティが trueのときの最小のフォントサイズを設定します。 Min Size
bool supportRichTexttrueにすると、textプロパティの内容をリッチテキストとして扱います。 Rich Text
string text 表示する文字列を設定します。 Text
VerticalWrapMode verticalOverflow
文字列がテキストの高さに収まらないときの表示方法を設定します。 Vertical Overflow
staticメソッド
public static Vector2 GetTextAnchorPivot(TextAnchor anchor)
TextAnchor(alignmentプロパティ)に対応するピボットの座標を返します。
publicメソッド
public TextGenerationSettings GetGenerationSettings(Vector2 extents)
テキストをプロパティをTextGenerationSettings構造体で返します。
Selectable
名前空間 : UnityEngine.UI継承 : UIBehaviour, IEventSystemHandler, IPointerEnterHandler, IPointerExitHandler, IPointerDownHandler,IPointerUpHandler, ISelectHandler, IDeselectHandler, IMoveHandler参照 : 4-9-1~4-9-3
publicプロパティ
プロパティ名 機能 対応するInspectorの項目
AnimationTriggers animationTriggers
状態によって再生するアニメーションのトリガーを設定します。transitionプロパティがAnimationのときのみ有効です。
Normal Trigger、HighlightedTrigger、Pressed Trigger、Disabled Trigger
Animator animatorアタッチされているAnimatorコンポーネントを返します(読み取り専用)。 -
ColorBlock colors状態によってグラフィック要素に適用する色を設定します。transitionプロパティがColorTintのときのみ有効です。
Normal Color、HighlightedColor、Pressed Color、Disabled Color
Image imagetransitionプロパティがColorTintまたはSpriteSwapのいずれかのとき、色またはスプライトを変更するイメージを設定します。内部では targetGraphicプロパティを設定しています。
Target Graphic
bool interactable UI要素が操作可能かどうかを設定します。 Interactable
Navigation navigation UI要素のNavigationを設定します。 Navigation
SpriteState spriteState状態によってグラフィック要素に適用するスプライトを設定します。transitionプロパティがSpriteSwapのときのみ有効です。
Highlighted Sprite、PressedSprite、Disabled Sprite
-
プロパティ名 機能 対応するInspectorの項目
Graphic targetGraphictransitionプロパティがColorTintまたはSpriteSwapのいずれかのとき、色またはスプライトを変更するグラフィック要素を設定します。 Target Graphic
Selectable.Transition transition
UI要素のTransitionを設定します。 Transition
publicメソッド
public Selectable FindSelectable(Vector3 dir)
dirで指定した方向の次の選択可能なオブジェクトを探します。
public virtual Selectable FindSelectableOnDown()
下方向の次の選択可能なオブジェクトを探します。
public virtual Selectable FindSelectableOnLeft()
左方向の次の選択可能なオブジェクトを探します。
public virtual Selectable FindSelectableOnRight()
右方向の次の選択可能なオブジェクトを探します。
public virtual Selectable FindSelectableOnUp()
上方向の次の選択可能なオブジェクトを探します。
public virtual bool IsInteractable()
UI要素が操作可能かどうかを返します。
public virtual void Select()
このオブジェクトを選択状態にします。
Button
名前空間 : UnityEngine.UI継承 : Selectable, IEventSystemHandler, IPointerClickHandler, ISubmitHandler参照 : 4-2-1、4-2-4、4-3-1~4-3-2、6-6-4~6-6-5、6-7-2~6-7-3
publicプロパティ
プロパティ名 機能 対応するInspectorの項目
Button.ButtonClickedEvent onClick
ボタンを押して放したときに発生するイベントを設定します。 -
-
Toggle
名前空間 : UnityEngine.UI継承 : Selectable, IEventSystemHandler, IPointerClickHandler, ISubmitHandler, ICanvasElement参照 : 4-4-1~4-4-4、6-1-1~6-1-5、6-3-4
publicフィールド
プロパティ名 機能 対応するInspectorの項目
Graphic graphic チェックマークとして表示するグラフィック要素を設定します。 Graphic
Toggle.ToggleEvent onValueChanged
トグルを押して放したときに発生するイベントを設定します。 -
Toggle.ToggleTransition toggleTransition
チェックマークの表示が切り替わるときの効果を設定します。 Toggle Transition
publicプロパティ
プロパティ名 機能 対応するInspectorの項目
ToggleGroup group トグルが所属するToggleGroupを設定します。 Group
bool isOn トグルのオン/オフ状態を設定・取得します。 Is On
ToggleGroup
名前空間 : UnityEngine.UI継承 : UIBehaviour参照 : 4-4-4、6-1-1~6-1-5、6-3-4
publicプロパティ
プロパティ名 機能 対応するInspectorの項目
bool allowSwitchOfftrueにすると、グループ内のすべてのトグルをオフにすることが可能になります。 Allow Switch Off
Slider
名前空間 : UnityEngine.UI継承 : Selectable, IEventSystemHandler, IInitializePotentialDragHandler, IDragHandler, ICanvasElement参照 : 4-5-1~4-5-3
publicプロパティ
プロパティ名 機能 対応するInspectorの項目
Slider.Direction direction スライダーの向きを設定します。 Direction
RectTransform fillRectスライド操作によってハンドルと最小値側の端との間で伸び縮みするオブジェクトのRect Transformを設定します。 Fill Rect
RectTransform handleRect ハンドルとなるオブジェクトのRect Transformを設定します。 Handle Rect
-
プロパティ名 機能 対応するInspectorの項目
float maxValue スライダーの最大値を設定します。 Max Value
float minValue スライダーの最小値を設定します。 Min Value
float normalizedValue スライダーの値を正規化された値(0.0~1.0)で設定します。 -
Slider.SliderEvent onValueChanged スライダーの値が変化したときに発生するイベントを設定します。 -
float value スライダーの値を設定・取得します。 Value
bool wholeNumbers trueにすると、スライダーの値を整数に制限します。 Whole Numbers
publicメソッド
public void SetDirection(Slider.Direction direction, bool includeRectLayouts)
スライダーの向きを変更します。includeRectLayoutsに trueを指定すると、スライダーのレイアウトも変更します。
Scrollbar
名前空間 : UnityEngine.UI継承 : Selectable, IEventSystemHandler, IBeginDragHandler, IInitializePotentialDragHandler, IDragHandler, ICanvasElement参照 : 4-6-1~4-6-3、4-7-2
publicプロパティ
プロパティ名 機能 対応するInspectorの項目
Scrollbar.Direction direction スクロールバーの向きを設定します。 Direction
RectTransform handleRect ハンドルとなるオブジェクトのRect Transformを設定します。 Handle Rect
int numberOfSteps ハンドルを操作したとき何段階にスナップするかを設定します。 Number Of Steps
Scrollbar.ScrollEvent onValueChanged
スクロールバーの値が変化したときに発生するイベントを設定します。 -
float size ハンドルのサイズを設定します。値の範囲は0.0~1.0です。 Size
float value スクロールバーの値を設定します。値の範囲は0.0~1.0です。 Value
publicメソッド
public void SetDirection(Scrollbar.Direction direction, bool includeRectLayouts)
スクロールバーの向きを変更します。includeRectLayoutsにtrueを指定すると、スライダーのレイアウトも変更します。
ScrollRect
名前空間 : UnityEngine.UI継承 : UIBehaviour, IEventSystemHandler, IBeginDragHandler, IInitializePotentialDragHandler, IDragHandler, IEndDragHandler, IScrollHandler, ICanvasElement参照 : 4-7-1~4-7-4、6-3-1~6-3-3、6-5-1~6-5-2、6-5-6
-
publicプロパティ
プロパティ名 機能 対応するInspectorの項目
RectTransform content スクロールさせる内容のRect Transformを設定します。 Content
float decelerationRateinertiaプロパティが trueのとき、慣性による動きの減速度を設定します。 Deceleration Rate
float elasticitymovementTypeプロパティがElasticのとき、端までスクロールしたときに元に戻る弾力の強さを設定します。 Elasticity
bool horizontal 横方向のスクロールを有効にします。 Horizontal
float horizontalNormalizedPosition
横方向のスクロール位置を正規化された値(0.0~1.0)で設定・取得します。 -
Scrollbar horizontalScrollbar 横方向のスクロールバーを設定します。 Horizontal Scrollbar
bool inertia trueにすると、スクロールに慣性が働きます。 Inertia
ScrollRect.MovementType movementType
端までスクロールしたときの挙動を設定します。 Movement Type
Vector2 normalizedPositionスクロール位置を (0.0, 0.0)~ (1.0, 1.0)に正規化された座標で設定・取得します。 -
ScrollRect.ScrollRectEvent onValueChanged
スクロールしたときに発生するイベントを設定します。 -
float scrollSensitivityマウスのスクロールホイールやトラックパッドの操作でスクロールさせたときの感度を設定します。 Scroll Sensitivity
Vector2 velocity 現在のスクロール速度を設定・取得します。 -
bool vertical 縦方向のスクロールを有効にします。 Vertical
float verticalNormalizedPosition
縦方向のスクロール位置を正規化された値(0.0~1.0)で設定・取得します。 -
Scrollbar verticalScrollbar 縦方向のスクロールバーを設定します。 Vertical Scrollbar
publicメソッド
public virtual void StopMovement()
ScrollRectの現在の動きを止めます。
InputField
名前空間 : UnityEngine.UI継承 : Selectable, IEventSystemHandler, IPointerClickHandler, IBeginDragHandler, IDragHandler, IEndDragHandler, IUpdateSelectedHandler, ISubmitHandler, ICanvasElement参照 : 4-8-1~4-8-3
publicプロパティ
プロパティ名 機能 対応するInspectorの項目
char asteriskCharinputTypeプロパティがPasswordのときに入力された文字の代わりに表示される文字を設定します。 -
float caretBlinkRate 入力中に表示されるキャレットの点滅速度を設定します。 Caret Blink Rate
int caretPosition 現在のキャレットの位置を設定・取得します。 -
int characterLimit 入力可能な最大の文字数を設定します。 Character Limit
InputField.CharacterValidation characterValidation
入力可能な文字種を設定します。 Character Validation
-
プロパティ名 機能 対応するInspectorの項目
InputField.ContentType contentType
インプットフィールドのタイプを設定します。 Content Type
InputField.InputType inputType
入力タイプを設定します。 Input Type
bool isFocusedインプットフィールドがフォーカスされているかどうかを返します(読み取り専用)。 -
TouchScreenKeyboardType keyboardType
モバイルデバイスで表示されるキーボードのタイプを設定します。 Keyboard Type
InputField.LineType lineType 行タイプを設定します。 Line Type
bool multiLineインプットフィールドが複数行の入力に対応しているかどうかを返します(読み取り専用)。lineTypeプロパティがMultiLineSubmitかMultiLineNewlineのとき、trueを返します。
-
InputField.SubmitEvent onEndEdit
入力が終了したときに発生するイベントを設定します。 -
InputField.OnValidateInput onValidateInput
文字が入力されたときに呼ばれるバリデーションメソッドを設定します。 -
InputField.OnChangeEvent onValueChange
入力中の文字列が変更されたときに発生するイベントを設定します。 -
Graphic placeholderインプットフィールドに何も入力されていないときに表示されるグラフィック要素を設定します。 Placeholder
int selectionAnchorPosition 選択されている文字列の先頭の位置を設定・取得します。 -
Color selectionColor 選択されている文字列の背景色を設定します。 Selection Color
int selectionFocusPosition 選択されている文字列の末尾の位置を設定・取得します。 -
bool shouldHideMobileInputtrueにすると、モバイルデバイスでの入力時に表示される補助用の入力フィールドが表示されません。 Hide Mobile Input
string text デフォルトの文字列を設定、または入力された文字列を取得します。 Text
Text textComponent 入力された文字列が表示されるテキストを設定します。 Text Component
bool wasCanceled 入力がキャンセルされたかどうかを返します(読み取り専用)。 -
publicメソッド
public void ActivateInputField()
インプットフィールドをアクティブにします。
public void DeactivateInputField()
インプットフィールドを非アクティブにします。
public void MoveTextEnd(bool shift)
キャレットを文字列の末尾に移動します。shiftに trueを指定すると、selectionAnchorPositionプロパティの値は保
持され、selectionFocusPositionプロパティの値のみが変化します。
public void MoveTextStart(bool shift)
キャレットを文字列の先頭に移動します。shiftに trueを指定すると、selectionAnchorPositionプロパティの値は保
持され、selectionFocusPositionプロパティの値のみが変化します。
public Vector2 ScreenToLocal(Vector2 screen)
スクリーン座標をインプットフィールドのローカル座標に変換します。
-
uGUI ではじめる
U nity U Iデザインの教科書[Unity 5 対応]
©2015 Masayuki Iwai
2015年8月31日 発行著者 岩井 雅幸発行者 中川 信行発行所 株式会社マイナビ URL:http://book.mynavi.jp
岩井 雅幸(Masayuki Iwai)千葉県生まれ、Windowsアプリケーション開発を皮切りに、Webサイトデザインからサーババックエンド開発、Flash・Silverlightなどによるインタラクティブコンテンツ制作など幅広い業務に携わる。iPhone 3G発表当初よりユーティリティや「ポケットベガス」など、数多くの iOSアプリケーションを開発。2012年には創業メンバーとしてAppBank Games 株式会社設立に参画、翌2013年には同社執行役員に就任、「ダンジョンズ&ゴルフ」や「トキノラビリンス」などを開発。現在AppBank株式会社所属。
著者プロフィール
丸山 弘詩(Hiroshi Maruyama)書籍編集者。iPhoneをはじめAndroidなどスマートフォン全般、BSD ならびにUNIX関連に深い造詣を持つ。関連書籍の執筆・編集はもちろん、アプリケーションの企画・開発、運用やプロモーションを手掛け、様々な分野のコンサルティングやプロダクトディレクションなども担当。
編集者プロフィール
特典PDF【非売品】
●このPDFは書籍『uGUIではじめるUnity UIデザインの教科書』の特典PDFです。