Class RenderObject | Package Manager UI website
docs.unity3d.com
    Show / Hide Table of Contents

    Class RenderObject

    Inheritance
    System.Object
    Diagnosticable
    DiagnosticableTree
    AbstractNodeMixinDiagnosticableTree
    RenderObject
    RenderBox
    RenderObjectWithChildMixinRenderObject<ChildType>
    RenderSliver
    Inherited Members
    AbstractNodeMixinDiagnosticableTree.depth
    AbstractNodeMixinDiagnosticableTree.redepthChild(AbstractNodeMixinDiagnosticableTree)
    AbstractNodeMixinDiagnosticableTree.redepthChildren()
    AbstractNodeMixinDiagnosticableTree.attached
    AbstractNodeMixinDiagnosticableTree.detach()
    AbstractNodeMixinDiagnosticableTree.parent
    DiagnosticableTree.toDiagnosticsNode(String, DiagnosticsTreeStyle)
    DiagnosticableTree.debugDescribeChildren()
    Diagnosticable.ToString()
    Namespace: Unity.UIWidgets.rendering
    Syntax
    public abstract class RenderObject : AbstractNodeMixinDiagnosticableTree, HitTestTarget

    Constructors

    RenderObject()

    Declaration
    protected RenderObject()

    Fields

    _relayoutBoundary

    Declaration
    public RenderObject _relayoutBoundary
    Field Value
    Type Description
    RenderObject

    debugCreator

    Declaration
    public object debugCreator
    Field Value
    Type Description
    System.Object

    parentData

    Declaration
    public ParentData parentData
    Field Value
    Type Description
    ParentData

    Properties

    alwaysNeedsCompositing

    Declaration
    protected virtual bool alwaysNeedsCompositing { get; }
    Property Value
    Type Description
    System.Boolean

    constraints

    Declaration
    public Constraints constraints { get; }
    Property Value
    Type Description
    Constraints

    debugActiveLayout

    Declaration
    public static RenderObject debugActiveLayout { get; }
    Property Value
    Type Description
    RenderObject

    debugActivePaint

    Declaration
    public static RenderObject debugActivePaint { get; }
    Property Value
    Type Description
    RenderObject

    debugCanParentUseSize

    Declaration
    public bool debugCanParentUseSize { get; }
    Property Value
    Type Description
    System.Boolean

    debugDoingThisLayout

    Declaration
    public bool debugDoingThisLayout { get; }
    Property Value
    Type Description
    System.Boolean

    debugDoingThisPaint

    Declaration
    public bool debugDoingThisPaint { get; }
    Property Value
    Type Description
    System.Boolean

    debugDoingThisResize

    Declaration
    public bool debugDoingThisResize { get; }
    Property Value
    Type Description
    System.Boolean

    debugLayer

    Declaration
    public OffsetLayer debugLayer { get; }
    Property Value
    Type Description
    OffsetLayer

    debugNeedsLayout

    Declaration
    public bool debugNeedsLayout { get; }
    Property Value
    Type Description
    System.Boolean

    isRepaintBoundary

    Declaration
    public virtual bool isRepaintBoundary { get; }
    Property Value
    Type Description
    System.Boolean

    layer

    Declaration
    public OffsetLayer layer { get; }
    Property Value
    Type Description
    OffsetLayer

    needsCompositing

    Declaration
    public bool needsCompositing { get; }
    Property Value
    Type Description
    System.Boolean

    owner

    Declaration
    public PipelineOwner owner { get; }
    Property Value
    Type Description
    PipelineOwner

    paintBounds

    Declaration
    public abstract Rect paintBounds { get; }
    Property Value
    Type Description
    Rect

    semanticBounds

    Declaration
    public abstract Rect semanticBounds { get; }
    Property Value
    Type Description
    Rect

    sizedByParent

    Declaration
    protected virtual bool sizedByParent { get; }
    Property Value
    Type Description
    System.Boolean

    Methods

    _updateCompositingBits()

    Declaration
    public void _updateCompositingBits()

    adoptChild(AbstractNodeMixinDiagnosticableTree)

    Declaration
    protected override void adoptChild(AbstractNodeMixinDiagnosticableTree childNode)
    Parameters
    Type Name Description
    AbstractNodeMixinDiagnosticableTree childNode
    Overrides
    AbstractNodeMixinDiagnosticableTree.adoptChild(AbstractNodeMixinDiagnosticableTree)

    applyPaintTransform(RenderObject, Matrix3)

    Declaration
    public virtual void applyPaintTransform(RenderObject child, Matrix3 transform)
    Parameters
    Type Name Description
    RenderObject child
    Matrix3 transform

    attach(Object)

    Declaration
    public override void attach(object ownerObject)
    Parameters
    Type Name Description
    System.Object ownerObject
    Overrides
    AbstractNodeMixinDiagnosticableTree.attach(Object)

    debugAssertDoesMeetConstraints()

    Declaration
    protected abstract void debugAssertDoesMeetConstraints()

    debugFillProperties(DiagnosticPropertiesBuilder)

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

    debugPaint(PaintingContext, Offset)

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

    debugRegisterRepaintBoundaryPaint(Boolean, Boolean)

    Declaration
    public virtual void debugRegisterRepaintBoundaryPaint(bool includedParent = true, bool includedChild = false)
    Parameters
    Type Name Description
    System.Boolean includedParent
    System.Boolean includedChild

    debugResetSize()

    Declaration
    protected virtual void debugResetSize()

    describeApproximatePaintClip(RenderObject)

    Declaration
    public virtual Rect describeApproximatePaintClip(RenderObject child)
    Parameters
    Type Name Description
    RenderObject child
    Returns
    Type Description
    Rect

    dropChild(AbstractNodeMixinDiagnosticableTree)

    Declaration
    protected override void dropChild(AbstractNodeMixinDiagnosticableTree childNode)
    Parameters
    Type Name Description
    AbstractNodeMixinDiagnosticableTree childNode
    Overrides
    AbstractNodeMixinDiagnosticableTree.dropChild(AbstractNodeMixinDiagnosticableTree)

    getTransformTo(RenderObject)

    Declaration
    public Matrix3 getTransformTo(RenderObject ancestor)
    Parameters
    Type Name Description
    RenderObject ancestor
    Returns
    Type Description
    Matrix3

    handleEvent(PointerEvent, HitTestEntry)

    Declaration
    public virtual void handleEvent(PointerEvent evt, HitTestEntry entry)
    Parameters
    Type Name Description
    PointerEvent evt
    HitTestEntry entry
    Implements
    HitTestTarget.handleEvent(PointerEvent, HitTestEntry)

    invokeLayoutCallback<T>(LayoutCallback<T>)

    Declaration
    protected void invokeLayoutCallback<T>(LayoutCallback<T> callback)
        where T : Constraints
    Parameters
    Type Name Description
    LayoutCallback<T> callback
    Type Parameters
    Name Description
    T

    layout(Constraints, Boolean)

    Declaration
    public void layout(Constraints constraints, bool parentUsesSize = false)
    Parameters
    Type Name Description
    Constraints constraints
    System.Boolean parentUsesSize

    markNeedsCompositingBitsUpdate()

    Declaration
    public void markNeedsCompositingBitsUpdate()

    markNeedsLayout()

    Declaration
    public virtual void markNeedsLayout()

    markNeedsLayoutForSizedByParentChange()

    Declaration
    public void markNeedsLayoutForSizedByParentChange()

    markNeedsPaint()

    Declaration
    public void markNeedsPaint()

    markParentNeedsLayout()

    Declaration
    protected void markParentNeedsLayout()

    paint(PaintingContext, Offset)

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

    performLayout()

    Declaration
    protected abstract void performLayout()

    performResize()

    Declaration
    protected abstract void performResize()

    replaceRootLayer(OffsetLayer)

    Declaration
    public void replaceRootLayer(OffsetLayer rootLayer)
    Parameters
    Type Name Description
    OffsetLayer rootLayer

    scheduleInitialLayout()

    Declaration
    public void scheduleInitialLayout()

    scheduleInitialPaint(ContainerLayer)

    Declaration
    public void scheduleInitialPaint(ContainerLayer rootLayer)
    Parameters
    Type Name Description
    ContainerLayer rootLayer

    setupParentData(RenderObject)

    Declaration
    public virtual void setupParentData(RenderObject child)
    Parameters
    Type Name Description
    RenderObject child

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

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

    toString(DiagnosticLevel)

    Declaration
    public override string toString(DiagnosticLevel minLevel = DiagnosticLevel.debug)
    Parameters
    Type Name Description
    DiagnosticLevel minLevel
    Returns
    Type Description
    System.String
    Overrides
    Diagnosticable.toString(DiagnosticLevel)

    toStringDeep(String, String, DiagnosticLevel)

    Declaration
    public override string toStringDeep(string prefixLineOne = "", string prefixOtherLines = "", DiagnosticLevel minLevel = DiagnosticLevel.debug)
    Parameters
    Type Name Description
    System.String prefixLineOne
    System.String prefixOtherLines
    DiagnosticLevel minLevel
    Returns
    Type Description
    System.String
    Overrides
    DiagnosticableTree.toStringDeep(String, String, DiagnosticLevel)

    toStringShallow(String, DiagnosticLevel)

    Declaration
    public override string toStringShallow(string joiner = ", ", DiagnosticLevel minLevel = DiagnosticLevel.debug)
    Parameters
    Type Name Description
    System.String joiner
    DiagnosticLevel minLevel
    Returns
    Type Description
    System.String
    Overrides
    DiagnosticableTree.toStringShallow(String, DiagnosticLevel)

    toStringShort()

    Declaration
    public override string toStringShort()
    Returns
    Type Description
    System.String
    Overrides
    DiagnosticableTree.toStringShort()

    visitChildren(RenderObjectVisitor)

    Declaration
    public virtual void visitChildren(RenderObjectVisitor visitor)
    Parameters
    Type Name Description
    RenderObjectVisitor visitor
    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