Navigation
API > API/Plugins > API/Plugins/VPUtilities
| Name | AVPBookmarkActor |
| Type | class |
| Header File | /Engine/Plugins/Experimental/VirtualProductionUtilities/Source/VPUtilities/Public/Actors/VPBookmarkActor.h |
| Include Path | #include "Actors/VPBookmarkActor.h" |
Syntax
UCLASS (
HideCategories=(Rendering, Lighting, HLOD, Mobile, Navigation, RayTracing, TextureStreaming),
CollapseCategories)
class AVPBookmarkActor :
public AVPViewportTickableActorBase ,
public IVPInteraction ,
public IVPBookmarkProvider
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → AActor → AVPViewportTickableActorBase → AVPBookmarkActor
Implements Interfaces
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
AVPBookmarkActor
(
const FObjectInitializer& ObjectInitializer |
Actors/VPBookmarkActor.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bIsFlagged | bool | Whether this was flagged by a user | Actors/VPBookmarkActor.h |
|
| BookmarkColor | FLinearColor | Color of Bookmark in MU Session | Actors/VPBookmarkActor.h |
|
| BookmarkMaterial | TObjectPtr< UMaterialInterface > | Actors/VPBookmarkActor.h |
|
|
| BookmarkMeshComponent | TObjectPtr< UStaticMeshComponent > | Mesh Representation in the world | Actors/VPBookmarkActor.h |
|
| BookmarkObject | TObjectPtr< UVPBookmark > | Reference to Editor Bookmark UObject | Actors/VPBookmarkActor.h |
|
| CameraComponent | TObjectPtr< UCineCameraComponent > | CineCamera | Actors/VPBookmarkActor.h |
|
| DynamicMaterial | TObjectPtr< UMaterialInstanceDynamic > | Actors/VPBookmarkActor.h |
|
|
| FavoriteLevel | int32 | Favorite status set by a user | Actors/VPBookmarkActor.h |
|
| IsHome | bool | Bool to determine if this bookmark should be designated the home location | Actors/VPBookmarkActor.h |
|
| NameTextRenderComponent | TObjectPtr< UTextRenderComponent > | Textrender to display bookmark name | Actors/VPBookmarkActor.h |
|
| SceneCaptureComponent | TObjectPtr< UCineCaptureComponent2D > | CineCaptureComponent | Actors/VPBookmarkActor.h |
|
| SnapshotTexture | TObjectPtr< UTexture2D > | Texture reference to store render of viewpoint | Actors/VPBookmarkActor.h |
|
| SplineMeshComponent | TObjectPtr< USplineMeshComponent > | Splinemesh | Actors/VPBookmarkActor.h |
|
| Timestamp | FDateTime | DateTime to store creation time | Actors/VPBookmarkActor.h |
|
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| BookmarkRotation | FRotator | Actors/VPBookmarkActor.h | ||
| BookmarkStaticMesh | TObjectPtr< UStaticMesh > | Actors/VPBookmarkActor.h | ||
| LabelMaterialInstance | TObjectPtr< UMaterialInterface > | Actors/VPBookmarkActor.h | ||
| SplineMaterial | TObjectPtr< UMaterialInterface > | Actors/VPBookmarkActor.h | ||
| SplineMaterialInstance | TObjectPtr< UMaterialInterface > | Actors/VPBookmarkActor.h | ||
| SplineStaticMesh | TObjectPtr< UStaticMesh > | Actors/VPBookmarkActor.h | ||
| TextMaterial | TObjectPtr< UMaterial > | Actors/VPBookmarkActor.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void CaptureSnapshot() |
Update SnapshotTexture captured via SceneCaptureComponent | Actors/VPBookmarkActor.h |
|
void GenerateBookmarkName_Implementation() |
Actors/VPBookmarkActor.h |
|
|
void HideBookmarkSplineMeshIndicator_Implementation() |
Actors/VPBookmarkActor.h |
|
|
void OnActorDroppedFromCarry_Implementation() |
Actors/VPBookmarkActor.h |
|
|
void OnActorDroppedFromTransform_Implementation() |
Actors/VPBookmarkActor.h |
|
|
void OnActorSelectedForTransform_Implementation() |
Actors/VPBookmarkActor.h |
|
|
void OnBookmarkActivation_Implementation
(
UVPBookmark* Bookmark, |
Actors/VPBookmarkActor.h |
|
|
void OnBookmarkChanged_Implementation
(
UVPBookmark* Bookmark |
Actors/VPBookmarkActor.h |
|
|
void UpdateBookmarkColor
(
FLinearColor Color |
Update the mesh color and BookmarkColor variable. Intended for use with multiuser initialization | Actors/VPBookmarkActor.h |
|
void UpdateBookmarkSplineMeshIndicator_Implementation() |
Actors/VPBookmarkActor.h |
|
|
void UpdateTimestamp() |
Update Timestamp property with current time | Actors/VPBookmarkActor.h |
|
Overridden from AActor
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void PostRegisterAllComponents() |
Actors/VPBookmarkActor.h | ||
virtual void Tick
(
float DeltaSeconds |
Actors/VPBookmarkActor.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
Actors/VPBookmarkActor.h |