Version 3.3.1.2

OdinGUIScrollView class

Namespace: Sirenix.OdinInspector.Editor.Internal
Assembly: Sirenix.OdinInspector.Editor
public class OdinGUIScrollView
Inheritance
  • System.Object
  • OdinGUIScrollView

Constructors

OdinGUIScrollView(Int32, Nullable<Int32>, Boolean)
public OdinGUIScrollView(int capacity, int? referenceCapacity = default(int? ), bool adjustViewForVerticalScrollBar = true)
Parameters
System.Int32 capacity

System.Nullable<System.Int32> referenceCapacity

System.Boolean adjustViewForVerticalScrollBar

Fields

Bounds
public Rect Bounds
Indentation
public float Indentation
InteractRect
public Rect InteractRect
SCROLL_BAR_SIZE
public const float SCROLL_BAR_SIZE = 12F
ViewRect
public Rect ViewRect

Properties

IsBeyondAnyBounds
public bool IsBeyondAnyBounds { get; }
IsBeyondBounds
public bool IsBeyondBounds { get; }
IsBeyondHorizontalBounds
public bool IsBeyondHorizontalBounds { get; }
IsBeyondVerticalBounds
public bool IsBeyondVerticalBounds { get; }
IsDraggingHorizontalScrollBar
public bool IsDraggingHorizontalScrollBar { get; }
IsDraggingMouse
public bool IsDraggingMouse { get; }
IsDraggingVerticalScrollBar
public bool IsDraggingVerticalScrollBar { get; }
Length
public int Length { get; }
Position
public Vector2 Position { get; set; }
PositionX
public float PositionX { get; set; }
PositionY
public float PositionY { get; set; }
ReferencedAmount
public int ReferencedAmount { get; }

Methods

AllocateRect(Single, Object)
Allocates an UnityEngine.Rect in the view, with the option to associate a given System.Object with it.
public void AllocateRect(float height, object reference = null)
Parameters
System.Single height

System.Object reference

BeginAllocations()
public void BeginAllocations()
BeginClip(Nullable<Rect>, Nullable<Vector2>, Boolean, Boolean)
public void BeginClip(Rect? clipRect = default(Rect? ), Vector2? offset = default(Vector2? ), bool ignoreScrollX = false, bool ignoreScrollY = false)
Parameters
System.Nullable<UnityEngine.Rect> clipRect

System.Nullable<UnityEngine.Vector2> offset

System.Boolean ignoreScrollX

System.Boolean ignoreScrollY

BeginScrollView(Nullable<Vector2>, Nullable<Vector2>, Single)
public void BeginScrollView(Vector2? offset = default(Vector2? ), Vector2? addViewSize = default(Vector2? ), float scrollSpeed = 36F)
Parameters
System.Nullable<UnityEngine.Vector2> offset

System.Nullable<UnityEngine.Vector2> addViewSize

System.Single scrollSpeed

EndAllocations()
public void EndAllocations()
EndClip()
public void EndClip()
EndScrollView()
public void EndScrollView()
GetClipRect()
public Rect GetClipRect()
Returns
UnityEngine.Rect

GetReferencedObject(Int32)
public object GetReferencedObject(int index)
Parameters
System.Int32 index

Returns
System.Object

GetViewClipRect()
public Rect GetViewClipRect()
Returns
UnityEngine.Rect

GetVisibleItems()
public OdinGUIScrollView.VisibleItems GetVisibleItems()
HandleMiddleMouseDrag(Boolean, Boolean, Single)
public bool HandleMiddleMouseDrag(bool inverted, bool useEvents = false, float speed = 1F)
Parameters
System.Boolean inverted

System.Boolean useEvents

System.Single speed

Returns
System.Boolean

ReallocateRect(Int32, Single, Object)
public void ReallocateRect(int index, float height, object reference = null)
Parameters
System.Int32 index

System.Single height

System.Object reference

Resize(Int32, Nullable<Int32>)
public void Resize(int capacity, int? referenceCapacity = default(int? ))
Parameters
System.Int32 capacity

System.Nullable<System.Int32> referenceCapacity

ResizeToFit()
public void ResizeToFit()
ScrollBackground(Rect, Boolean)
public static void ScrollBackground(Rect position, bool isVertical)
Parameters
UnityEngine.Rect position

System.Boolean isVertical

ScrollButton(Rect, Boolean)
public static bool ScrollButton(Rect position, bool isDragging)
Parameters
UnityEngine.Rect position

System.Boolean isDragging

Returns
System.Boolean

ScrollTo(Single, Single, Single, Easing, Boolean)
public void ScrollTo(float speed, float xPosition = NaNF, float yPosition = NaNF, Easing easing = Easing.Linear, bool waitUntilDone = true)
Parameters
System.Single speed

System.Single xPosition

System.Single yPosition

Easing easing

System.Boolean waitUntilDone

ScrollTo(Vector2, Single, Easing, Boolean)
public void ScrollTo(Vector2 position, float speed, Easing easing = Easing.Linear, bool waitUntilDone = true)
Parameters
UnityEngine.Vector2 position

System.Single speed

Easing easing

System.Boolean waitUntilDone

SetBounds(Rect, Single)
public void SetBounds(Rect bounds, float viewWidth = NaNF)
Parameters
UnityEngine.Rect bounds

System.Single viewWidth

SetBoundsForCurrentAllocations(Rect, Single)
public void SetBoundsForCurrentAllocations(Rect bounds, float viewWidth = NaNF)
Parameters
UnityEngine.Rect bounds

System.Single viewWidth

Space(Single)
public void Space(float amount)
Parameters
System.Single amount