Version: 2018.1
语言: 中文

ScrollRect

class in UnityEngine.UI

/

继承自：EventSystems.UIBehaviour


实现接口：IBeginDragHandler, ICanvasElement, IDragHandler, IEndDragHandler, IEventSystemHandler, IInitializePotentialDragHandler, ILayoutController, ILayoutElement, ILayoutGroup, IScrollHandler

切换到手册

描述

用于使子 RectTransform 滚动的组件。

ScrollRect 将不自行执行任何裁剪。在与 Mask 组件组合后，它可以变为滚动视图。

变量

content可以滚动的内容。应为 GameObject 的子项，其中包含 ScrollRect。
decelerationRate移动减速的速率。
elasticity在内容移动至滚动矩形之外时使用的弹性值。
flexibleHeight由布局系统调用。
flexibleWidth由布局系统调用。
horizontal是否应启用水平滚动？
horizontalNormalizedPosition水平滚动位置，以 0 到 1 之间的值表示，0 表示位于左侧。
horizontalScrollbar可选的 Scrollbar 对象，已链接至 ScrollRect 的水平滚动。
horizontalScrollbarSpacing滚动条与视口之间的空间。
horizontalScrollbarVisibility水平滚动条的可见性模式。
inertia是否应启用运动惯性？
layoutPriority由布局系统调用。
minHeight由布局系统调用。
minWidth由布局系统调用。
movementType在内容移动至滚动矩形之外时使用的行为。
normalizedPosition滚动位置，表示为 (0,0) 与 (1,1) 之间的 Vector2，(0,0) 表示位于左下角。
onValueChanged在子项的位置更改时执行的回调。
preferredHeight由布局系统调用。
preferredWidth由布局系统调用。
scrollSensitivity对滚轮和触控板滚动事件的敏感性。
velocity内容的当前速度。
vertical是否应启用垂直滚动？
verticalNormalizedPosition垂直滚动位置，以 0 到 1 之间的值表示，0 表示位于底部。
verticalScrollbar可选的 Scrollbar 对象，已链接至 ScrollRect 的垂直滚动。
verticalScrollbarSpacing滚动条与视口之间的空间。
verticalScrollbarVisibility垂直滚动条的可见性模式。
viewport引用作为内容 RectTransform 的父级的视口 RectTransform。

公共函数

CalculateLayoutInputHorizontal由布局系统调用。
CalculateLayoutInputVertical由布局系统调用。
GraphicUpdateComplete请参阅 ICanvasElement.GraphicUpdateComplete。
IsActive请参阅基类中的成员。
LayoutComplete请参阅 ICanvasElement.LayoutComplete。
OnBeginDrag拖动内容时的处理。
OnDrag拖动内容时的处理。
OnEndDrag完成内容拖动时的处理。
OnInitializePotentialDrag请参阅：IInitializePotentialDragHandler.OnInitializePotentialDrag。
OnScroll请参阅 IScrollHandler.OnScroll。
Rebuild在初始化之后重新构建滚动矩形数据。
SetLayoutHorizontal由布局系统调用。
SetLayoutVertical由布局系统调用。
StopMovement将两个轴上的速度都设置为 0，使内容停止移动。

受保护的函数

OnDisable请参阅 MonoBehaviour.OnDisable。
SetContentAnchoredPosition设置内容的锚定位置。
SetDirty用于修改代码或添加至代码的重写，可使滚动矩形的外观与其数据保持同步。
SetDirtyCaching用于修改代码或添加至代码的重写，可缓存数据以避免重复的繁重操作。
SetNormalizedPosition将水平或垂直滚动位置设置为 0 到 1 之间的值，0 表示位于左侧或底部。
UpdateBounds计算 ScrollRect 应使用的边界。
UpdatePrevDataHelper 函数，用于更新 ScrollRect 上之前的数据字段。在更改 ScrollRect 中的数据之前，请调用此函数。

继承的成员

变量

enabled启用的 Behaviour 可更新，禁用的 Behaviour 不可更新。
isActiveAndEnabled已调用启用的 Behaviour。
gameObject此组件附加到的游戏对象。始终将组件附加到游戏对象。
tag此游戏对象的标签。
transform附加到此 GameObject 的 Transform。
runInEditMode允许 MonoBehaviour 的特定实例在编辑模式下运行（仅可在 Editor 中使用）。
useGUILayout禁用该属性可跳过 GUI 布局阶段。
hideFlags该对象应该隐藏、随场景一起保存还是由用户修改？
name对象的名称。

公共函数

BroadcastMessage调用此游戏对象或其任何子项中的每个 MonoBehaviour 上名为 methodName 的方法。
CompareTag此游戏对象是否使用 tag 进行了标记？
GetComponent如果游戏对象附加了类型为 type 的组件，则将其返回，否则返回 null。
GetComponentInChildren使用深度首次搜索返回 GameObject 或其任何子项中类型为 type 的组件。
GetComponentInParent返回 GameObject 或其任何父项中类型为 type 的组件。
GetComponents返回 GameObject 中类型为 type 的所有组件。
GetComponentsInChildren返回 GameObject 或其任何子项中类型为 type 的所有组件。
GetComponentsInParent返回 GameObject 或其任何父项中类型为 type 的所有组件。
SendMessage调用此游戏对象中的每个 MonoBehaviour 上名为 methodName 的方法。
SendMessageUpwards调用此游戏对象中的每个 MonoBehaviour 上或此行为的每个父级上名为 methodName 的方法。
CancelInvoke取消该 MonoBehaviour 上的所有 Invoke 调用。
Invoke在 time 秒后调用 methodName 方法。
InvokeRepeating在 time 秒后调用 methodName 方法，然后每 repeatRate 秒调用一次。
IsInvoking是否有任何待处理的 methodName 调用？
StartCoroutine启动一个协同程序。
StopAllCoroutines停止在该行为上运行的所有协同程序。
StopCoroutine停止在该行为上运行的第一个名为 methodName 的协同程序或存储在 routine 中的协同程序。
GetInstanceID返回对象的实例 ID。
ToString返回 GameObject 的名称。
IsDestroyed如果行为的原生表示已被销毁，则返回 true。

受保护的函数

Awake请参阅 MonoBehaviour.Awake。
OnBeforeTransformParentChanged请参阅 MonoBehaviour.OnBeforeTransformParentChanged。
OnCanvasGroupChanged请参阅 MonoBehaviour.OnCanvasGroupChanged。
OnCanvasHierarchyChanged在父画布的状态发生更改时调用。
OnDestroy请参阅 MonoBehaviour.OnDestroy。
OnDidApplyAnimationProperties请参阅 LayoutGroup.OnDidApplyAnimationProperties。
OnEnable请参阅 MonoBehaviour.OnEnable。
OnRectTransformDimensionsChange如果关联的 RectTransform 的尺寸发生更改，则系统会调用此回调。
OnTransformParentChanged请参阅 MonoBehaviour.OnRectTransformParentChanged。
OnValidate请参阅 MonoBehaviour.OnValidate。
Reset请参阅 MonoBehaviour.Reset。
Start请参阅 MonoBehaviour.Start。

静态函数

print将消息记录到 Unity 控制台（与 Debug.Log 相同）。
Destroy删除 GameObject、组件或资源。
DestroyImmediate立即销毁对象 /obj/。强烈建议您改用 Destroy。
DontDestroyOnLoad加载新场景时，不自动销毁对象 /target/。
FindObjectOfType返回第一个类型为 type 的已加载的激活对象。
FindObjectsOfType返回所有类型为 type 的已加载的激活对象的列表。
Instantiate克隆 original 对象并返回克隆对象。

运算符

bool该对象是否存在？
operator !=比较两个对象是否引用不同的对象。
operator ==比较两个对象引用，判断它们是否引用同一个对象。

消息

AwakeAwake 在加载脚本实例时调用。
FixedUpdate用于物理计算且独立于帧率的 MonoBehaviour.FixedUpdate 消息。
LateUpdate如果启用了 Behaviour，则每帧调用 LateUpdate。
OnAnimatorIK用于设置动画 IK（反向运动学）的回调。
OnAnimatorMove用于处理动画移动以修改根运动的回调。
OnApplicationFocus当玩家获得或失去焦点时，发送给所有 GameObject。
OnApplicationPause当应用程序暂停时，发送给所有 GameObject。
OnApplicationQuit在应用程序退出前，发送给所有游戏对象。
OnAudioFilterRead如果实现了 OnAudioFilterRead，Unity 将在音频 DSP 链中插入一个自定义滤波器。
OnBecameInvisibleOnBecameInvisible 在渲染器对任何摄像机都不可见时调用。
OnBecameVisibleOnBecameVisible 在渲染器变为对任意摄像机可见时调用。
OnCollisionEnter当该碰撞体/刚体已开始接触另一个刚体/碰撞体时，调用 OnCollisionEnter。
OnCollisionEnter2D当传入碰撞体与该对象的碰撞体接触时发送（仅限 2D 物理）。
OnCollisionExit当该碰撞体/刚体已停止接触另一个刚体/碰撞体时，调用 OnCollisionExit。
OnCollisionExit2D当另一个对象上的碰撞体停止接触该对象的碰撞体时发送（仅限 2D 物理）。
OnCollisionStay对应正在接触刚体/碰撞体的每一个碰撞体/刚体，每帧调用一次 :ref::OnCollisionStay。
OnCollisionStay2D在另一个对象上的碰撞体正在接触该对象的碰撞体时发送每个帧（仅限 2D 物理）。
OnConnectedToServer成功连接到服务器后在客户端上调用。
OnControllerColliderHit当该控制器在执行 Move 时撞到碰撞体时调用 OnControllerColliderHit。
OnDestroy销毁附加的行为将导致游戏或场景收到 OnDestroy。
OnDisconnectedFromServer当连接丢失或与服务器断开连接时，在客户端上调用。
OnDrawGizmos如果您想绘制能够选择并且始终绘制的辅助图标，则可以实现 OnDrawGizmos。
OnDrawGizmosSelected如果选择了对象，则实现 OnDrawGizmosSelected 来绘制辅助图标。
OnEnable该函数在对象变为启用和激活状态时调用。
OnFailedToConnect出于某种原因连接尝试失败时，在客户端上调用。
OnFailedToConnectToMasterServer在连接到 MasterServer 时发生问题的情况下，在客户端或服务器上调用。
OnGUI系统调用 OnGUI 来渲染和处理 GUI 事件。
OnJointBreak在附加到相同游戏对象的关节断开时调用。
OnJointBreak2D在附加到相同游戏对象的 Joint2D 断开时调用。
OnMasterServerEvent在从 MasterServer 报告事件时，在客户端或服务器上调用。
OnMouseDown当用户在 GUIElement 或 Collider 上按下鼠标按钮时，将调用 OnMouseDown。
OnMouseDrag当用户单击 GUIElement 或 Collider 并仍然按住鼠标时，将调用 OnMouseDrag。
OnMouseEnter当鼠标进入 GUIElement 或 Collider 时调用。
OnMouseExit当鼠标不再处于 GUIElement 或 Collider 上方时调用。
OnMouseOver当鼠标悬停在 GUIElement 或 Collider 上时，每帧调用一次。
OnMouseUp当用户松开鼠标按钮时，将调用 OnMouseUp。
OnMouseUpAsButton松开鼠标时，仅当鼠标在按下时所在的 GUIElement 或 Collider 上时，才调用 OnMouseUpAsButton。
OnNetworkInstantiate在已通过 Network.Instantiate 进行网络实例化的对象上调用。
OnParticleCollision当粒子击中碰撞体时，将调用 OnParticleCollision。
OnParticleTrigger当粒子系统中的任何粒子满足触发模块中的条件时，将调用 OnParticleTrigger。
OnPlayerConnected每当有新玩家成功连接，就在服务器上调用。
OnPlayerDisconnected每当有玩家与服务器断开连接，就在服务器上调用。
OnPostRender在摄像机完成场景渲染后，将调用 OnPostRender。
OnPreCullOnPreCull 在摄像机剔除场景前调用。
OnPreRenderOnPreRender 在摄像机开始渲染场景前调用。
OnRenderImageOnRenderImage 在图像的所有渲染操作全部完成后调用。
OnRenderObjectOnRenderObject 在摄像机渲染场景后调用。
OnSerializeNetworkView用于在网络视图监视的脚本中自定义变量同步。
OnServerInitialized每当调用 Network.InitializeServer 并且完成时，对该服务器调用该函数。
OnTransformChildrenChanged当 GameObject 的变换的子项列表发生更改时，将调用该函数。
OnTransformParentChanged当 GameObject 的变换的父属性发生更改时，将调用该函数。
OnTriggerEnter当 Collider other 事件进入该触发器时调用 OnTriggerEnter。
OnTriggerEnter2D当另一个对象进入附加到该对象的触发碰撞体时发送（仅限 2D 物理）。
OnTriggerExit当 Collider other 已停止接触该触发器时调用 OnTriggerExit。
OnTriggerExit2D当另一个对象离开附加到该对象的触发碰撞体时发送（仅限 2D 物理）。
OnTriggerStay对于接触触发器的每一个 Collider /other/，每次物理更新调用一次 OnTriggerStay。
OnTriggerStay2D在另一个对象位于附加到该对象的触发碰撞体之内时发送每个帧（仅限 2D 物理）。
OnValidate加载脚本后或 Inspector 中的值发生更改时，将调用该函数（只能在 Editor 中调用）。
OnWillRenderObject如果对象可见并且不是 UI 元素，则为每个摄像机调用 OnWillRenderObject。
Reset重置为默认值。
Start在首次调用任何 Update 方法之前启用脚本时，在帧上调用 Start。
Update如果启用了 MonoBehaviour，则每帧调用 Update。
Copyright © 2023 Unity Technologies
优美缔软件（上海）有限公司 版权所有
"Unity"、Unity 徽标及其他 Unity 商标是 Unity Technologies 或其附属机构在美国及其他地区的商标或注册商标。其他名称或品牌是其各自所有者的商标。
公安部备案号:
31010902002961