Class RenderViewportBase<ParentDataClass> | Package Manager UI website
docs.unity3d.com
    Show / Hide Table of Contents

    Class RenderViewportBase<ParentDataClass>

    Inheritance
    System.Object
    Diagnosticable
    DiagnosticableTree
    AbstractNodeMixinDiagnosticableTree
    RenderObject
    RenderBox
    ContainerRenderObjectMixinRenderBox<RenderSliver, ParentDataClass>
    RenderViewportBase<ParentDataClass>
    RenderShrinkWrappingViewport
    RenderViewport
    Inherited Members
    ContainerRenderObjectMixinRenderBox<RenderSliver, ParentDataClass>.childCount
    ContainerRenderObjectMixinRenderBox<RenderSliver, ParentDataClass>.debugValidateChild(RenderObject)
    ContainerRenderObjectMixinRenderBox<RenderSliver, ParentDataClass>.insert(RenderSliver, RenderSliver)
    ContainerRenderObjectMixinRenderBox<RenderSliver, ParentDataClass>.add(RenderSliver)
    ContainerRenderObjectMixinRenderBox<RenderSliver, ParentDataClass>.addAll(List<RenderSliver>)
    ContainerRenderObjectMixinRenderBox<RenderSliver, ParentDataClass>._removeFromChildList(RenderSliver)
    ContainerRenderObjectMixinRenderBox<RenderSliver, ParentDataClass>.remove(RenderSliver)
    ContainerRenderObjectMixinRenderBox<RenderSliver, ParentDataClass>.removeAll()
    ContainerRenderObjectMixinRenderBox<RenderSliver, ParentDataClass>.move(RenderSliver, RenderSliver)
    ContainerRenderObjectMixinRenderBox<RenderSliver, ParentDataClass>.attach(Object)
    ContainerRenderObjectMixinRenderBox<RenderSliver, ParentDataClass>.detach()
    ContainerRenderObjectMixinRenderBox<RenderSliver, ParentDataClass>.redepthChildren()
    ContainerRenderObjectMixinRenderBox<RenderSliver, ParentDataClass>.visitChildren(RenderObjectVisitor)
    ContainerRenderObjectMixinRenderBox<RenderSliver, ParentDataClass>.firstChild
    ContainerRenderObjectMixinRenderBox<RenderSliver, ParentDataClass>.lastChild
    ContainerRenderObjectMixinRenderBox<RenderSliver, ParentDataClass>.childBefore(RenderSliver)
    ContainerRenderObjectMixinRenderBox<RenderSliver, ParentDataClass>.childAfter(RenderSliver)
    ContainerRenderObjectMixinRenderBox<RenderSliver, ParentDataClass>.debugDescribeChildren()
    ContainerRenderObjectMixinRenderBox<RenderSliver, ParentDataClass>.ContainerRenderObjectMixin.insert(RenderObject, RenderObject)
    ContainerRenderObjectMixinRenderBox<RenderSliver, ParentDataClass>.ContainerRenderObjectMixin.remove(RenderObject)
    ContainerRenderObjectMixinRenderBox<RenderSliver, ParentDataClass>.ContainerRenderObjectMixin.move(RenderObject, RenderObject)
    ContainerRenderObjectMixinRenderBox<RenderSliver, ParentDataClass>.ContainerRenderObjectMixin.firstChild
    ContainerRenderObjectMixinRenderBox<RenderSliver, ParentDataClass>.ContainerRenderObjectMixin.lastChild
    ContainerRenderObjectMixinRenderBox<RenderSliver, ParentDataClass>.ContainerRenderObjectMixin.childBefore(RenderObject)
    ContainerRenderObjectMixinRenderBox<RenderSliver, ParentDataClass>.ContainerRenderObjectMixin.childAfter(RenderObject)
    RenderBox.setupParentData(RenderObject)
    RenderBox.getMinIntrinsicWidth(Single)
    RenderBox.getMaxIntrinsicWidth(Single)
    RenderBox.getMinIntrinsicHeight(Single)
    RenderBox.getMaxIntrinsicHeight(Single)
    RenderBox.hasSize
    RenderBox.size
    RenderBox.debugAdoptSize(Size)
    RenderBox.semanticBounds
    RenderBox.debugResetSize()
    RenderBox.getDistanceToBaseline(TextBaseline, Boolean)
    RenderBox.getDistanceToActualBaseline(TextBaseline)
    RenderBox.computeDistanceToActualBaseline(TextBaseline)
    RenderBox.constraints
    RenderBox.debugAssertDoesMeetConstraints()
    RenderBox.markNeedsLayout()
    RenderBox.performResize()
    RenderBox.performLayout()
    RenderBox.hitTest(HitTestResult, Offset)
    RenderBox.hitTestSelf(Offset)
    RenderBox.applyPaintTransform(RenderObject, Matrix3)
    RenderBox.globalToLocal(Offset, RenderObject)
    RenderBox.localToGlobal(Offset, RenderObject)
    RenderBox.paintBounds
    RenderBox.debugHandleEvent(PointerEvent, HitTestEntry)
    RenderBox.debugPaint(PaintingContext, Offset)
    RenderBox.debugPaintBaselines(PaintingContext, Offset)
    RenderBox.debugPaintPointers(PaintingContext, Offset)
    RenderObject.parentData
    RenderObject.adoptChild(AbstractNodeMixinDiagnosticableTree)
    RenderObject.dropChild(AbstractNodeMixinDiagnosticableTree)
    RenderObject.visitChildren(RenderObjectVisitor)
    RenderObject.debugCreator
    RenderObject.debugDoingThisResize
    RenderObject.debugDoingThisLayout
    RenderObject.debugActiveLayout
    RenderObject.debugCanParentUseSize
    RenderObject.owner
    RenderObject.debugNeedsLayout
    RenderObject._relayoutBoundary
    RenderObject.markParentNeedsLayout()
    RenderObject.markNeedsLayoutForSizedByParentChange()
    RenderObject.scheduleInitialLayout()
    RenderObject.layout(Constraints, Boolean)
    RenderObject.sizedByParent
    RenderObject.invokeLayoutCallback<T>(LayoutCallback<T>)
    RenderObject.debugDoingThisPaint
    RenderObject.debugActivePaint
    RenderObject.debugRegisterRepaintBoundaryPaint(Boolean, Boolean)
    RenderObject.alwaysNeedsCompositing
    RenderObject.layer
    RenderObject.debugLayer
    RenderObject.markNeedsCompositingBitsUpdate()
    RenderObject.needsCompositing
    RenderObject._updateCompositingBits()
    RenderObject.markNeedsPaint()
    RenderObject.scheduleInitialPaint(ContainerLayer)
    RenderObject.replaceRootLayer(OffsetLayer)
    RenderObject.getTransformTo(RenderObject)
    RenderObject.handleEvent(PointerEvent, HitTestEntry)
    RenderObject.toStringShort()
    RenderObject.toString(DiagnosticLevel)
    RenderObject.toStringDeep(String, String, DiagnosticLevel)
    RenderObject.toStringShallow(String, DiagnosticLevel)
    AbstractNodeMixinDiagnosticableTree.depth
    AbstractNodeMixinDiagnosticableTree.redepthChild(AbstractNodeMixinDiagnosticableTree)
    AbstractNodeMixinDiagnosticableTree.redepthChildren()
    AbstractNodeMixinDiagnosticableTree.attached
    DiagnosticableTree.toDiagnosticsNode(String, DiagnosticsTreeStyle)
    Diagnosticable.ToString()
    Namespace: Unity.UIWidgets.rendering
    Syntax
    public abstract class RenderViewportBase<ParentDataClass> : ContainerRenderObjectMixinRenderBox<RenderSliver, ParentDataClass>, HitTestTarget, ContainerRenderObjectMixin, RenderAbstractViewport where ParentDataClass : ParentData, ContainerParentDataMixin<RenderSliver>
    Type Parameters
    Name Description
    ParentDataClass

    Constructors

    RenderViewportBase(AxisDirection, AxisDirection, ViewportOffset, Single)

    Declaration
    protected RenderViewportBase(AxisDirection axisDirection = AxisDirection.down, AxisDirection crossAxisDirection = AxisDirection.right, ViewportOffset offset = null, float cacheExtent = 250F)
    Parameters
    Type Name Description
    AxisDirection axisDirection
    AxisDirection crossAxisDirection
    ViewportOffset offset
    System.Single cacheExtent

    Properties

    axis

    Declaration
    public Axis axis { get; }
    Property Value
    Type Description
    Axis

    axisDirection

    Declaration
    public AxisDirection axisDirection { get; set; }
    Property Value
    Type Description
    AxisDirection

    cacheExtent

    Declaration
    public float cacheExtent { get; set; }
    Property Value
    Type Description
    System.Single

    childrenInHitTestOrder

    Declaration
    protected abstract IEnumerable<RenderSliver> childrenInHitTestOrder { get; }
    Property Value
    Type Description
    System.Collections.Generic.IEnumerable<RenderSliver>

    childrenInPaintOrder

    Declaration
    protected abstract IEnumerable<RenderSliver> childrenInPaintOrder { get; }
    Property Value
    Type Description
    System.Collections.Generic.IEnumerable<RenderSliver>

    crossAxisDirection

    Declaration
    public AxisDirection crossAxisDirection { get; set; }
    Property Value
    Type Description
    AxisDirection

    hasVisualOverflow

    Declaration
    protected abstract bool hasVisualOverflow { get; }
    Property Value
    Type Description
    System.Boolean

    indexOfFirstChild

    Declaration
    protected abstract int indexOfFirstChild { get; }
    Property Value
    Type Description
    System.Int32

    isRepaintBoundary

    Declaration
    public override bool isRepaintBoundary { get; }
    Property Value
    Type Description
    System.Boolean
    Overrides
    RenderObject.isRepaintBoundary

    offset

    Declaration
    public ViewportOffset offset { get; set; }
    Property Value
    Type Description
    ViewportOffset

    parent

    Declaration
    public RenderObject parent { get; }
    Property Value
    Type Description
    RenderObject
    Implements
    RenderAbstractViewport.parent

    Methods

    _paintContents(PaintingContext, Offset)

    Declaration
    public void _paintContents(PaintingContext context, Offset offset)
    Parameters
    Type Name Description
    PaintingContext context
    Offset offset

    attach(Object)

    Declaration
    public override void attach(object owner)
    Parameters
    Type Name Description
    System.Object owner
    Overrides
    Unity.UIWidgets.rendering.ContainerRenderObjectMixinRenderBox<Unity.UIWidgets.rendering.RenderSliver, ParentDataClass>.attach(System.Object)

    computeAbsolutePaintOffset(RenderSliver, Single, GrowthDirection)

    Declaration
    protected Offset computeAbsolutePaintOffset(RenderSliver child, float layoutOffset, GrowthDirection growthDirection)
    Parameters
    Type Name Description
    RenderSliver child
    System.Single layoutOffset
    GrowthDirection growthDirection
    Returns
    Type Description
    Offset

    computeChildMainAxisPosition(RenderSliver, Single)

    Declaration
    protected abstract float computeChildMainAxisPosition(RenderSliver child, float parentMainAxisPosition)
    Parameters
    Type Name Description
    RenderSliver child
    System.Single parentMainAxisPosition
    Returns
    Type Description
    System.Single

    computeMaxIntrinsicHeight(Single)

    Declaration
    protected override float computeMaxIntrinsicHeight(float width)
    Parameters
    Type Name Description
    System.Single width
    Returns
    Type Description
    System.Single
    Overrides
    RenderBox.computeMaxIntrinsicHeight(Single)

    computeMaxIntrinsicWidth(Single)

    Declaration
    protected override float computeMaxIntrinsicWidth(float height)
    Parameters
    Type Name Description
    System.Single height
    Returns
    Type Description
    System.Single
    Overrides
    RenderBox.computeMaxIntrinsicWidth(Single)

    computeMinIntrinsicHeight(Single)

    Declaration
    protected override float computeMinIntrinsicHeight(float width)
    Parameters
    Type Name Description
    System.Single width
    Returns
    Type Description
    System.Single
    Overrides
    RenderBox.computeMinIntrinsicHeight(Single)

    computeMinIntrinsicWidth(Single)

    Declaration
    protected override float computeMinIntrinsicWidth(float height)
    Parameters
    Type Name Description
    System.Single height
    Returns
    Type Description
    System.Single
    Overrides
    RenderBox.computeMinIntrinsicWidth(Single)

    debugDescribeChildren()

    Declaration
    public override List<DiagnosticsNode> debugDescribeChildren()
    Returns
    Type Description
    System.Collections.Generic.List<DiagnosticsNode>
    Overrides
    Unity.UIWidgets.rendering.ContainerRenderObjectMixinRenderBox<Unity.UIWidgets.rendering.RenderSliver, ParentDataClass>.debugDescribeChildren()

    debugFillProperties(DiagnosticPropertiesBuilder)

    Declaration
    public override void debugFillProperties(DiagnosticPropertiesBuilder properties)
    Parameters
    Type Name Description
    DiagnosticPropertiesBuilder properties
    Overrides
    RenderBox.debugFillProperties(DiagnosticPropertiesBuilder)

    debugPaintSize(PaintingContext, Offset)

    Declaration
    protected override void debugPaintSize(PaintingContext context, Offset offset)
    Parameters
    Type Name Description
    PaintingContext context
    Offset offset
    Overrides
    RenderBox.debugPaintSize(PaintingContext, Offset)

    debugThrowIfNotCheckingIntrinsics()

    Declaration
    protected virtual bool debugThrowIfNotCheckingIntrinsics()
    Returns
    Type Description
    System.Boolean

    describeApproximatePaintClip(RenderObject)

    Declaration
    public override Rect describeApproximatePaintClip(RenderObject childRaw)
    Parameters
    Type Name Description
    RenderObject childRaw
    Returns
    Type Description
    Rect
    Overrides
    RenderObject.describeApproximatePaintClip(RenderObject)

    detach()

    Declaration
    public override void detach()
    Overrides
    Unity.UIWidgets.rendering.ContainerRenderObjectMixinRenderBox<Unity.UIWidgets.rendering.RenderSliver, ParentDataClass>.detach()

    getOffsetToReveal(RenderObject, Single, Rect)

    Declaration
    public RevealedOffset getOffsetToReveal(RenderObject target, float alignment, Rect rect = null)
    Parameters
    Type Name Description
    RenderObject target
    System.Single alignment
    Rect rect
    Returns
    Type Description
    RevealedOffset
    Implements
    RenderAbstractViewport.getOffsetToReveal(RenderObject, Single, Rect)

    hitTestChildren(HitTestResult, Offset)

    Declaration
    protected override bool hitTestChildren(HitTestResult result, Offset position = null)
    Parameters
    Type Name Description
    HitTestResult result
    Offset position
    Returns
    Type Description
    System.Boolean
    Overrides
    RenderBox.hitTestChildren(HitTestResult, Offset)

    labelForChild(Int32)

    Declaration
    protected abstract string labelForChild(int index)
    Parameters
    Type Name Description
    System.Int32 index
    Returns
    Type Description
    System.String

    layoutChildSequence(RenderSliver, Single, Single, Single, Single, Single, Single, GrowthDirection, Func<RenderSliver, RenderSliver>, Single, Single)

    Declaration
    protected float layoutChildSequence(RenderSliver child, float scrollOffset, float overlap, float layoutOffset, float remainingPaintExtent, float mainAxisExtent, float crossAxisExtent, GrowthDirection growthDirection, Func<RenderSliver, RenderSliver> advance, float remainingCacheExtent, float cacheOrigin)
    Parameters
    Type Name Description
    RenderSliver child
    System.Single scrollOffset
    System.Single overlap
    System.Single layoutOffset
    System.Single remainingPaintExtent
    System.Single mainAxisExtent
    System.Single crossAxisExtent
    GrowthDirection growthDirection
    System.Func<RenderSliver, RenderSliver> advance
    System.Single remainingCacheExtent
    System.Single cacheOrigin
    Returns
    Type Description
    System.Single

    maxScrollObstructionExtentBefore(RenderSliver)

    Declaration
    protected abstract float maxScrollObstructionExtentBefore(RenderSliver child)
    Parameters
    Type Name Description
    RenderSliver child
    Returns
    Type Description
    System.Single

    paint(PaintingContext, Offset)

    Declaration
    public override void paint(PaintingContext context, Offset offset)
    Parameters
    Type Name Description
    PaintingContext context
    Offset offset
    Overrides
    RenderObject.paint(PaintingContext, Offset)

    paintOffsetOf(RenderSliver)

    Declaration
    protected abstract Offset paintOffsetOf(RenderSliver child)
    Parameters
    Type Name Description
    RenderSliver child
    Returns
    Type Description
    Offset

    scrollOffsetOf(RenderSliver, Single)

    Declaration
    protected abstract float scrollOffsetOf(RenderSliver child, float scrollOffsetWithinChild)
    Parameters
    Type Name Description
    RenderSliver child
    System.Single scrollOffsetWithinChild
    Returns
    Type Description
    System.Single

    showInViewport(RenderObject, Rect, RenderAbstractViewport, ViewportOffset, Nullable<TimeSpan>, Curve)

    Declaration
    public static Rect showInViewport(RenderObject descendant = null, Rect rect = null, RenderAbstractViewport viewport = null, ViewportOffset offset = null, TimeSpan? duration = default(TimeSpan? ), Curve curve = null)
    Parameters
    Type Name Description
    RenderObject descendant
    Rect rect
    RenderAbstractViewport viewport
    ViewportOffset offset
    System.Nullable<System.TimeSpan> duration
    Curve curve
    Returns
    Type Description
    Rect

    showOnScreen(RenderObject, Rect, Nullable<TimeSpan>, Curve)

    Declaration
    public override void showOnScreen(RenderObject descendant, Rect rect, TimeSpan? duration = default(TimeSpan? ), Curve curve = null)
    Parameters
    Type Name Description
    RenderObject descendant
    Rect rect
    System.Nullable<System.TimeSpan> duration
    Curve curve
    Overrides
    RenderObject.showOnScreen(RenderObject, Rect, Nullable<TimeSpan>, Curve)

    updateChildLayoutOffset(RenderSliver, Single, GrowthDirection)

    Declaration
    protected abstract void updateChildLayoutOffset(RenderSliver child, float layoutOffset, GrowthDirection growthDirection)
    Parameters
    Type Name Description
    RenderSliver child
    System.Single layoutOffset
    GrowthDirection growthDirection

    updateOutOfBandData(GrowthDirection, SliverGeometry)

    Declaration
    protected abstract void updateOutOfBandData(GrowthDirection growthDirection, SliverGeometry childLayoutGeometry)
    Parameters
    Type Name Description
    GrowthDirection growthDirection
    SliverGeometry childLayoutGeometry
    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023