『uGUIではじめるUnity UIデザインの教科書』特典PDF【非売品】

特典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プロパティ
プロパティ名
機能
int cachedSortingLayerValue
sortingLayerID プロパティに基づいて計算されキャッシュされた
描画順序の値を返します
（読み取り専用）
。
-
ルートのカンバスかどうかを返します
（読み取り専用）
。
-
bool overridePixelPerfect
true にすると、ネストしたカンバスの親の pixelPerfect プロパテ
ィの設定を無視します。
-
bool overrideSorting
true にすると、ネストしたカンバスの親の描画順序設定を無視し
ます。
-
bool pixelPerfect
true にすると、カンバス内の UI 要素がピクセルに合うように描画
されます。renderMode プロパティが ScreenSpaceOverlay か
ScreenSpaceCamera のときのみ有効です。
Pixel Perfect
bool isRootCanvas
Rect pixelRect
float planeDistance
float referencePixelsPerUnit
RenderMode renderMode
int renderOrder
対応する Inspector の項目
カンバスの描画領域の矩形を返します
（読み取り専用）
。
renderMode プロパティが ScreenSpaceOverlay のときは、画面
全体の矩形になります。WorldSpace のときは、カメラのビュー
ポートの矩形になります。
カンバスのカメラからの距離を設定します。
Plane Distance
デフォルトの 1 単位あたりのピクセル数を設定します。
-
カンバスの描画モードを設定します。
Render Mode
カンバスが描画される順番を返します
（読み取り専用）
。
-
float scaleFactor
カンバス上のすべての UI 要素をスケールする倍率を設定します。
CanvasScaler.scaleFactor によって設定されます。
int sortingLayerID
カンバスのソーティングレイヤーを ID で設定します。
Sorting Layer
カンバスのソーティングレイヤーを名前で設定します。
Sorting Layer
string sortingLayerName
int sortingOrder
Camera worldCamera
ソーティングレイヤー内での描画順序を設定します。
Sort Order、Order in Layer
カンバスを描画するカメラを設定します。
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プロパティ
プロパティ名
機能
float defaultSpriteDPI
Pixels Per Unit が referencePixelsPerUnit プロパティの値と同じス
プライトに対する、1 インチあたりのピクセル数を設定します。
Default Sprite DPI
float dynamicPixelsPerUnit
動的に生成されるグラフィックの 1 単位あたりのピクセル数を設定
します。
Dynamic Pixels Per Unit
DPI が不明な場合に使用される DPI の値を設定します。
Fallback Screen DPI
screenMatchMode プロパティが MatchWidthOrHeight のとき、参
照解像度の幅と高さのどちらに合わせるかを設定します。
Match
UI 要素の位置やサイズを設定する物理単位を設定します。
Physical Unit
float referencePixelsPerUnit
カンバス上での基準となる 1 単位あたりのピクセル数を設定します。
Reference Pixels Per Unit
Vector2 referenceResolution
作成する UI の基準となる参照解像度を設定します。
Reference Resolution
カンバス上のすべての UI 要素をスケールする倍率を設定します。
Scale Factor
CanvasScaler.
ScreenMatchMode
screenMatchMode
画面解像度と参照解像度のアスペクト比が異なるとき、カンバスを
どのようにスケールするかを設定します。
Screen Match Mode
CanvasScaler.ScaleMode
uiScaleMode
カンバス内の UI 要素がどのようにスケールされるかを設定します。
Ui Scale Mode
float fallbackScreenDPI
float matchWidthOrHeight
CanvasScaler.Unit
physicalUnit
float scaleFactor
対応する Inspector の項目
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プロパティ
プロパティ名
int absoluteDepth
bool isMask
int relativeDepth
機能
対応する Inspector の項目
ルートのカンバスからの深さを返します
（読み取り専用）
。
-
このレンダラーに Mask コンポーネントがアタッチされている場
合、true を返します。
-
親のカンバスからの相対的な深さを返します
（読み取り専用）
。
-
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<UIVertex> vertices)
レンダラーによって描画される頂点を設定します。
CanvasGroup
名前空間 : UnityEngine
継承 : Component, ICanvasRaycastFilter
参照 : 2-1-8、6-2-1 ∼ 6-2-3
publicプロパティ
プロパティ名
機能
対応する Inspector の項目
カンバスグループのアルファを設定します。
Alpha
bool blocksRaycasts
カンバスグループに含まれる UI 要素がレイキャストをブロックす
るかどうか
（衝突判定を許可するかどうか）
を設定します。
Blocks Raycasts
bool ignoreParentGroups
親のカンバスグループで設定されているプロパティを無視するか
どうかを設定します。
Ignore Parent Groups
bool interactable
カンバスグループに含まれる UI 要素が操作可能かどうかを設定
します。
Interactable
float alpha
RectTransform
名前空間 : UnityEngine
継承 : Transform
参照 : 2-2-1 ∼ 2-2-4、6-3-3、6-5-4、6-6-3 ∼ 6-6-4
publicプロパティ
プロパティ名
機能
Vector2 anchoredPosition
UI 要素の位置を設定します。アンカーからの相対座標でピボットの位置
の座標を示しています。アンカーが開いているときは、各アンカーハン
ドル間の中間点からの相対座標になります。
対応する Inspector の項目
Pos X、Pos Y
Vector3 anchoredPosition3D
UI 要素の 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
ピボットの位置を設定します。
Pivot
Rect rect
ローカル座標系での矩形を示す Rect 構造体を返します
（読み取り専用）
。
-
Vector2 sizeDelta
UI 要素の幅と高さを設定します。アンカーが閉じているときに設定可能
です。
Width、Height
Vector2 pivot
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プロパティ
プロパティ名
EventSystem current
機能
現在のイベントシステムを返します。
対応する Inspector の項目
-
publicプロパティ
プロパティ名
機能
bool alreadySelecting
ゲームオブジェクトが選択状態になっている場合に true を返します
（読み取り専用）
。
対応する Inspector の項目
-
BaseInputModule
currentInputModule
現在アクティブなインプットモジュールを返します
（読み取り専用）
。
-
プロパティ名
機能
GameObject
currentSelectedGameObject
現在選択されているゲームオブジェクトを返します
（読み取り専用）
。
-
開始時に選択状態にするゲームオブジェクトを設定します。
First Selected
int pixelDragThreshold
ドラッグを開始したとみなす移動距離をピクセル単位で設定します。
Drag Threshold
bool sendNavigationEvents
true にすると、キーボードやゲームコントローラーを操作したときに
発生するナビゲーションイベントを送信します。
Send Navigation Events
GameObject
firstSelectedGameObject
対応する Inspector の項目
publicメソッド
public bool IsPointerOverGameObject()
public bool IsPointerOverGameObject(int pointerId)
マウスカーソルやタッチポイントがイベントシステムに対応したゲームオブジェクトの上にあるかどうかを返します。
public void RaycastAll(PointerEventData eventData, List<RaycastResult> 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プロパティ
プロパティ名
bool
allowActivationOnMobileDevice
機能
true にすると、モバイルデバイスでもアクティブにすることができます。
対応する Inspector
の項目
Allow Activation
On Mobile Device
string cancelButton
キャンセルボタンに対応するインプットマネージャーの設定を指定します。
Cancel Button
string horizontalAxis
横方向の軸のボタンに対応するインプットマネージャーの設定を指定します。
Horizontal Axis
float inputActionsPerSecond
キーボードやゲームコントローラーの入力を 1 秒間に何回受け付けるかを設定
します。
Input Actions Per
Second
float repeatDelay
string submitButton
string verticalAxis
連続入力を受け付け始めるまでの遅延を設定します。
Repeat Delay
決定ボタンに対応するインプットマネージャーの設定を指定します。
Submit Button
縦方向の軸のボタンに対応するインプットマネージャーの設定を指定します。
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プロパティ
プロパティ名
機能
GraphicRaycaster.
BlockingObjects
blockingObjects
レイキャストをブロックするオブジェクトのタイプを設定します。
Blocking Objects
レイを発生するカメラを設定します。
-
Camera eventCamera
bool ignoreReversedGraphics
対応する Inspector の項目
true にすると、反転して裏面が表示されている要素は無視されます。 Ignore Reversed Graphics
int renderOrderPriority
描画の順序に基づくレイキャスターの優先度を返します
（読み取り
専用）
。
-
int sortOrderPriority
ソートの順序に基づくレイキャスターの優先度を返します
（読み取
り専用）
。
-
publicメソッド
public void Raycast(PointerEventData eventData, List<RaycastResult> resultAppendList)
シーンに対してレイキャストをおこないます。
PhysicsRaycaster
名前空間 : UnityEngine.EventSystems
継承 : BaseRaycaster
参照 : 2-3-5
publicプロパティ
プロパティ名
機能
int depth
このレイキャスターで使用するカメラの深度を返します
（読み取り
専用）
。
対応する Inspector の項目
-
Camera eventCamera
このレイキャスターで使用するカメラを返します
（読み取り専用）
。 -
LayerMask eventMask
レイキャストの許可するレイヤーマスクを設定します。
int finalEventMask
eventMask プロパティとカメラのマスクの論理積（AND）
による
最終的なマスクを返します
（読み取り専用）
。
-
int sortOrderPriority
ソートの順序に基づくレイキャスターの優先度を返します
（読み
取り専用）
。
-
publicメソッド
public override void Raycast(PointerEventData eventData, List<RaycastResult> 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プロパティ
プロパティ名
機能
float eventAlphaThreshold
イベントを通過させる最小のアルファ
（ピクセルのアルファ）
を設
定します。デフォルトの値は 1.0 です。
-
float fillAmount
塗りつぶしの量を設定します。type プロパティが Filled のときの
み有効です。
Fill Amount
bool fillCenter
true にすると、スライスが設定されているスプライトのとき、ス
ライスの中央部分も描画します。type プロパティが Sliced か
Filled のときのみ有効です。
Fill Center
bool fillClockwise
塗りつぶしの方向を設定します。type プロパティが Filled かつ
fillMethod プロパティが Radial90、Radial180、Radial360 のい
ずれかのときのみ有効です。
Clockwise
Image.FillMethod fillMethod
塗りつぶしの方法を設定します。type プロパティが Filled のとき
のみ有効です。
Fill Method
int fillOrigin
対応する Inspector の項目
塗りつぶしの基準点を設定します。type プロパティが Filled のと
きのみ有効です。fillMethod によって値の範囲は、Image.
OriginHorizontal、Image.OriginVertical、Image.Origin90、 Fill Origin
Image.Origin180、Image.Origin360 のいずれかの enum 値の範
囲になります。
スプライトにスライスが設定されているかどうかを返します
（読み
取り専用）
。
-
Texture mainTexture
スプライトのテクスチャを返します
（読み取り専用）
。
-
Sprite overrideSprite
表示をオーバーライドするスプライトを設定します。null を設定
すると sprite プロパティで設定しているスプライトを表示します。
-
bool hasBorder
float pixelsPerUnit
bool preserveAspect
Sprite sprite
Image.Type type
Camera worldCamera
1 単位あたりのピクセル数を返します
（読み取り専用）
。
-
true にすると、スプライトの縦横比を保って表示します。
Preserve Aspect Ratio
表示するスプライトを設定します。
Source Image
イメージの種類を設定します。
Image Type
カンバスを描画するカメラを設定します。
Render Camera、Event Camera
publicメソッド
public override void SetNativeSize()
イメージをスプライトのサイズ
（ピクセル等倍）
にリサイズします。
RawImage
名前空間 : UnityEngine.UI
継承 : MaskableGraphic
参照 : 3-4-1 ∼ 3-4-2、Chapter 6 コラム
（P.316）
publicプロパティ
プロパティ名
Texture mainTexture
Texture texture
Rect uvRect
機能
対応する Inspector の項目
表示しているテクスチャを返します
（読み取り専用）
。
-
表示するテクスチャを設定します。
Texture
ローイメージの領域内での、テクスチャのオフセットとサイズを
設定します。
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プロパティ
プロパティ名
TextAnchor alignment
機能
文字列の配置を設定します。
対応する Inspector の項目
Alignment
テキストを生成するときに使われる TextGenerator を返します
（読み取り専用）
。
-
TextGenerator
レイアウトを決定するときに使われる TextGenerator を返します
cachedTextGeneratorForLayout （読み取り専用）
。
-
テキストの描画にデフォルトで使用される静的なマテリアルを返
します
（読み取り専用）
。
-
フォントを設定します。
Font
フォントサイズをピクセル単位で設定します。
Font Size
フォントのスタイルを設定します。
Font Style
文字列がテキストの幅に収まらないときの折り返し方法を設定し
ます。
Horizontal Overflow
行の間隔を設定します。
Line Spacing
TextGenerator
cachedTextGenerator
Material defaultMaterial
Font font
int fontSize
FontStyle fontStyle
HorizontalWrapMode
horizontalOverflow
float lineSpacing
プロパティ名
機能
対応する Inspector の項目
フォントのテクスチャを返します
（読み取り専用）
。
-
（読み取り専用）
。
1 単位あたりのピクセル数を返します
-
bool resizeTextForBestFit
true にすると、文字列がテキストの領域に収まるように、自動的
にフォントサイズを変更して表示します。
Best Fit
int resizeTextMaxSize
resizeTextForBestFit プロパティが true のときの最大のフォント
サイズを設定します。
Max Size
int resizeTextMinSize
resizeTextForBestFit プロパティが true のときの最小のフォント
サイズを設定します。
Min Size
bool supportRichText
true にすると、text プロパティの内容をリッチテキストとして扱
います。
Rich Text
表示する文字列を設定します。
Text
文字列がテキストの高さに収まらないときの表示方法を設定しま
す。
Vertical Overflow
Texture mainTexture
float pixelsPerUnit
string text
VerticalWrapMode
verticalOverflow
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
Normal Trigger、Highlighted
状態によって再生するアニメーションのトリガーを設定します。
Trigger、Pressed Trigger、
transition プロパティが Animation のときのみ有効です。
Disabled Trigger
Animator animator
アタッチされている Animator コンポーネントを返します
（読み取り
専用）
。
ColorBlock colors
Normal Color、Highlighted
状態によってグラフィック要素に適用する色を設定します。
Color、Pressed Color、
transition プロパティが ColorTint のときのみ有効です。
Disabled Color
Image image
-
transition プロパティが ColorTint または SpriteSwap のいずれかの
とき、色またはスプライトを変更するイメージを設定します。内部
では targetGraphic プロパティを設定しています。
Target Graphic
UI 要素が操作可能かどうかを設定します。
Interactable
Navigation navigation
UI 要素の Navigation を設定します。
Navigation
SpriteState spriteState
状態によってグラフィック要素に適用するスプライトを設定します。 Highlighted Sprite、Pressed
Sprite、Disabled Sprite
transition プロパティが SpriteSwap のときのみ有効です。
bool interactable
プロパティ名
Graphic targetGraphic
Selectable.Transition
transition
機能
対応する Inspector の項目
transition プロパティが ColorTint または SpriteSwap のいずれかの
Target Graphic
とき、
色またはスプライトを変更するグラフィック要素を設定します。
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プロパティ
プロパティ名
Button.ButtonClickedEvent
onClick
機能
ボタンを押して放したときに発生するイベントを設定します。
対応する Inspector の項目
-
Toggle
名前空間 : UnityEngine.UI
継承 : Selectable, IEventSystemHandler, IPointerClickHandler, ISubmitHandler, ICanvasElement
参照 : 4-4-1 ∼ 4-4-4、6-1-1 ∼ 6-1-5、6-3-4
publicフィールド
プロパティ名
機能
Graphic graphic
チェックマークとして表示するグラフィック要素を設定します。
Graphic
対応する Inspector の項目
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プロパティ
プロパティ名
機能
bool allowSwitchOff
true にすると、グループ内のすべてのトグルをオフにすることが
可能になります。
対応する Inspector の項目
Allow Switch Off
Slider
名前空間 : UnityEngine.UI
継承 : Selectable, IEventSystemHandler, IInitializePotentialDragHandler, IDragHandler, ICanvasElement
参照 : 4-5-1 ∼ 4-5-3
publicプロパティ
プロパティ名
Slider.Direction direction
RectTransform fillRect
RectTransform handleRect
機能
対応する Inspector の項目
スライダーの向きを設定します。
Direction
スライド操作によってハンドルと最小値側の端との間で伸び縮み
するオブジェクトの Rect Transform を設定します。
Fill Rect
ハンドルとなるオブジェクトの Rect Transform を設定します。
Handle Rect
プロパティ名
機能
対応する Inspector の項目
float maxValue
スライダーの最大値を設定します。
Max Value
float minValue
スライダーの最小値を設定します。
Min Value
スライダーの値を正規化された値（0.0 ∼ 1.0）
で設定します。
-
float normalizedValue
Slider.SliderEvent onValueChanged
float value
bool wholeNumbers
スライダーの値が変化したときに発生するイベントを設定します。スライダーの値を設定・取得します。
Value
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
スクロールバーの値が変化したときに発生するイベントを設定し
ます。
-
ハンドルのサイズを設定します。値の範囲は 0.0 ∼ 1.0 です。
Size
スクロールバーの値を設定します。値の範囲は 0.0 ∼ 1.0 です。
Value
float size
float 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 decelerationRate
inertia プロパティが true のとき、慣性による動きの減速度を設定
します。
Deceleration Rate
float elasticity
movementType プロパティが Elastic のとき、端までスクロール
したときに元に戻る弾力の強さを設定します。
Elasticity
bool horizontal
横方向のスクロールを有効にします。
Horizontal
float
horizontalNormalizedPosition
横方向のスクロール位置を正規化された値（0.0 ∼ 1.0）
で設定・
取得します。
-
Scrollbar horizontalScrollbar
横方向のスクロールバーを設定します。
Horizontal Scrollbar
true にすると、スクロールに慣性が働きます。
Inertia
ScrollRect.MovementType
movementType
端までスクロールしたときの挙動を設定します。
Movement Type
Vector2 normalizedPosition
スクロール位置を (0.0, 0.0) ∼ (1.0, 1.0) に正規化された座標で設
定・取得します。
-
ScrollRect.ScrollRectEvent
onValueChanged
スクロールしたときに発生するイベントを設定します。
-
マウスのスクロールホイールやトラックパッドの操作でスクロー
ルさせたときの感度を設定します。
Scroll Sensitivity
bool inertia
float scrollSensitivity
現在のスクロール速度を設定・取得します。
-
縦方向のスクロールを有効にします。
Vertical
float
verticalNormalizedPosition
縦方向のスクロール位置を正規化された値（0.0 ∼ 1.0）
で設定・
取得します。
-
Scrollbar verticalScrollbar
縦方向のスクロールバーを設定します。
Vertical Scrollbar
Vector2 velocity
bool vertical
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プロパティ
プロパティ名
機能
char asteriskChar
inputType プロパティが Password のときに入力された文字の代わ
りに表示される文字を設定します。
対応する Inspector の項目
-
入力中に表示されるキャレットの点滅速度を設定します。
Caret Blink Rate
int caretPosition
現在のキャレットの位置を設定・取得します。
-
int characterLimit
入力可能な最大の文字数を設定します。
Character Limit
入力可能な文字種を設定します。
Character Validation
float caretBlinkRate
InputField.
CharacterValidation
characterValidation
プロパティ名
InputField.ContentType
contentType
InputField.InputType
inputType
機能
対応する Inspector の項目
インプットフィールドのタイプを設定します。
Content Type
入力タイプを設定します。
Input Type
bool isFocused
インプットフィールドがフォーカスされているかどうかを返します
（読み取り専用）
。
TouchScreenKeyboardType
keyboardType
モバイルデバイスで表示されるキーボードのタイプを設定します。
Keyboard Type
-
行タイプを設定します。
Line Type
インプットフィールドが複数行の入力に対応しているかどうかを返
します
（読み取り専用）
。lineType プロパティが MultiLineSubmit か
MultiLineNewline のとき、true を返します。
-
入力が終了したときに発生するイベントを設定します。
-
InputField.OnValidateInput
onValidateInput
文字が入力されたときに呼ばれるバリデーションメソッドを設定し
ます。
-
InputField.OnChangeEvent
onValueChange
入力中の文字列が変更されたときに発生するイベントを設定します。 -
InputField.LineType lineType
bool multiLine
InputField.SubmitEvent
onEndEdit
Graphic placeholder
int selectionAnchorPosition
Color selectionColor
int selectionFocusPosition
bool shouldHideMobileInput
string text
Text textComponent
bool wasCanceled
インプットフィールドに何も入力されていないときに表示されるグ
ラフィック要素を設定します。
Placeholder
選択されている文字列の先頭の位置を設定・取得します。
-
選択されている文字列の背景色を設定します。
Selection Color
選択されている文字列の末尾の位置を設定・取得します。
-
true にすると、モバイルデバイスでの入力時に表示される補助用の
入力フィールドが表示されません。
Hide Mobile Input
デフォルトの文字列を設定、または入力された文字列を取得します。 Text
入力された文字列が表示されるテキストを設定します。
Text Component
入力がキャンセルされたかどうかを返します
（読み取り専用）
。
-
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)
スクリーン座標をインプットフィールドのローカル座標に変換します。
著者プロフィール
岩井雅幸（Masayuki Iwai ）
千葉県生まれ、Windows アプリケーション開発を皮切りに、Web サイトデザインから
サーババックエンド開発、Flash ・Silverlightなどによるインタラクティブコンテンツ制
作など幅広い業務に携わる。
iPhone 3G 発表当初よりユーティリティや「ポケットベガス」など、数多くの iOS アプ
リケーションを開発。2012 年には創業メンバーとして AppBank Games 株式会社設立
に参画、翌 2013 年には同社執行役員に就任、
「ダンジョンズ＆ゴルフ」や「トキノラビ
リンス」などを開発。現在 AppBank 株式会社所属。
編集者プロフィール
丸山弘詩（Hiroshi Maruyama）
書籍編集者。iPhone をはじめ Androidなどスマートフォン全般、BSD ならびに UNIX 関
連に深い造詣を持つ。関連書籍の執筆・編集はもちろん、アプリケーションの企画・開発、
運用やプロモーションを手掛け、様々な分野のコンサルティングやプロダクトディレク
ションなども担当。
uGUI ではじめる
U nity U I デザインの教科書
［ Unity 5 対応］特典PDF【非売品】
2015 年 8 月 31 日発行
著者
発行者
発行所
岩井雅幸
中川信行
株式会社マイナビ
URL ：http://book.mynavi.jp
©2015 Masayuki Iwai
●このPDFは書籍『uGUIではじめるUnity UIデザインの教科書』の特典PDFです。

Download Report