Navigation
API > API/Runtime > API/Runtime/Slate
A ScissorRectBox is a widget that clips all its children using a scissor rect that matches it clipping rect in LAYOUT SPACE (the way it is provided in OnPaint). This ensures that any child widgets with render transforms do not "bleed out" of this parent container. Note there is a significant performance impact to using one of these widgets because any widgets inside this one end up in a separate set of batches using that scissor rect.
Keep in mind that this widget will use the LAYOUT clipping rect to clip children, since hardware clipping rects do not support non-aligned rectangles. If a render transform is applied to this widget itself, the results will not be as expected.
NOTE: This class is provided as a STOPGAP for design-time widgets (like the UMG designer itself) until a more robust clipping solution can be put in place.
| Name | SScissorRectBox |
| Type | class |
| Header File | /Engine/Source/Runtime/Slate/Public/Widgets/Layout/SScissorRectBox.h |
| Include Path | #include "Widgets/Layout/SScissorRectBox.h" |
Syntax
class SScissorRectBox : public SPanel
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → SWidget → SPanel → SScissorRectBox
- FSlateControlledConstruction → SWidget → SPanel → SScissorRectBox
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
SScissorRectBox() |
Widgets/Layout/SScissorRectBox.h |
Structs
| Name | Remarks |
|---|---|
| FArguments |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FScissorRectSlot | FSingleWidgetChildrenWithSlot | Widgets/Layout/SScissorRectBox.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ChildSlot | FScissorRectSlot | Widgets/Layout/SScissorRectBox.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void Construct
(
const FArguments& InArgs |
Widgets/Layout/SScissorRectBox.h | ||
void SetContent
(
const TSharedRef< SWidget >& InContent |
See the Content slot. | Widgets/Layout/SScissorRectBox.h |