Navigation
API > API/Plugins > API/Plugins/DMXPixelMappingRuntime > API/Plugins/DMXPixelMappingRuntime/Components
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UDMXPixelMappingBaseComponent
- UDMXPixelMappingOutputComponent
- UDMXPixelMappingFixtureGroupComponent
- UDMXPixelMappingMatrixCellComponent
- UDMXPixelMappingOutputDMXComponent
- UDEPRECATED_DMXPixelMappingScreenComponent
- UDMXPixelMappingFixtureGroupItemComponent
- UDMXPixelMappingMatrixComponent
- UDMXPixelMappingRendererComponent
References
| Module | DMXPixelMappingRuntime |
| Header | /Engine/Plugins/VirtualProduction/DMX/DMXPixelMapping/Source/DMXPixelMappingRuntime/Public/Components/DMXPixelMappingOutputComponent.h |
| Include | #include "Components/DMXPixelMappingOutputComponent.h" |
Syntax
UCLASS (Abstract)
class UDMXPixelMappingOutputComponent : public UDMXPixelMappingBaseComponent
Remarks
Base class for all Designer and configurable components
Variables
| Type | Name | Description | |
|---|---|---|---|
| bool | bLockInDesigner | ||
| bool | bVisibleInDesigner | ||
| FDMXPixelMappingComponentGeometryCache | CachedGeometry | ||
| FLinearColor | EditorColor | The color displayed in editor | |
| FVector2D | EditorPositionWithRotation | ||
| float | PositionX | ||
| float | PositionY | ||
| double | Rotation | ||
| float | SizeX | ||
| float | SizeY | ||
| int32 | ZOrder | ZOrder in the UI |
Constructors
| Type | Name | Description | |
|---|---|---|---|
| Default Constructor |
Functions
| Type | Name | Description | |
|---|---|---|---|
| UDMXPixelMappingRendererComponent * | Helper that returns render component if available | ||
| int32 | Get pixel index in downsample texture | ||
| void | Returns the edges of the component, absolute, rotated, clockwise order | ||
| FLinearColor | Returns an editor color for the widget | ||
| FName | Property Name getters. | ||
| const FText | Returns the text of palette category | ||
| FVector2D | GetPosition () |
Returns the absolute position, without rotation | |
| FVector2D | Returns the absolute position with rotation. | ||
| FName | |||
| FName | |||
| double | GetRotation () |
Gets the absolute rotation, in degrees | |
| FName | |||
| FVector2D | GetSize () |
Get the absolute size | |
| FName | |||
| FName | |||
| FName | |||
| int32 | GetZOrder () |
Returns the UI ZOrder | |
| void | Invalidates the pixel map, effectively causing the renderer component to aquire a new pixel map | ||
| bool | Whether component should be part of Palette view | ||
| bool | Whether component can be re-sized or re-position at the editor | ||
| bool | IsOverParent () |
Returns true if the the component's over all its parents. | |
| bool | IsOverPosition
(
const FVector2D& Position |
Returns true if the component is over specified position | |
| bool | IsVisible () |
Whether component should be visible | |
| bool | OverlapsComponent
(
UDMXPixelMappingOutputComponent* Other |
Returns true if the component overlaps the other | |
| void | Queue rendering to downsample rendering target | ||
| void | SetPosition
(
const FVector2D& NewPosition |
Sets the absolute position of the component, without rotation. | |
| void | SetPositionRotated
(
FVector2D NewRotatedPosition |
Sets the the absolute position with rotation. | |
| void | SetRotation
(
double NewRotation |
Sets the absolute rotation, in degrees | |
| void | Sets the absolue size | ||
| void | Sets the ZOrder in the UI | ||
| void | Updates children to match the size of this instance Z-orders this component and its children topmost |
Overridden from UDMXPixelMappingBaseComponent
| Type | Name | Description | |
|---|---|---|---|
| bool | CanBeMovedTo
(
const UDMXPixelMappingBaseComponent* Component |
Check if a Component can be moved under another one (used for copy/move/duplicate) |
Overridden from UObject
| Type | Name | Description | |
|---|---|---|---|
| void | PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
Called when a property on this object has been modified externally | |
| void | Called after the C++ constructor and after the properties have been initialized, including those loaded from config. | ||
| void | PostLoad () |
Do any object-specific cleanup required immediately after loading an object. |