Can't find any content

Error loading documents tree: Nothing found

  1. Epic GamesDeveloper
  3. UThumbnailRenderer

UThumbnailRenderer

This is an abstract base class that is used to define the interface that UnrealEd will use when rendering a given object's thumbnail.

API > API/Editor > API/Editor/UnrealEd > API/Editor/UnrealEd/ThumbnailRendering

Inheritance Hierarchy

References

   
Module UnrealEd
Header /Engine/Source/Editor/UnrealEd/Classes/ThumbnailRendering/ThumbnailRenderer.h
Include #include "ThumbnailRendering/ThumbnailRenderer.h"

Syntax

class UThumbnailRenderer : public UObject

Remarks

This is an abstract base class that is used to define the interface that UnrealEd will use when rendering a given object's thumbnail. The editor only calls the virtual rendering function.

Constructors

  Type Name Description
Public function  

UThumbnailRenderer ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Virtual bool Returns true if the renderer is capable of producing a thumbnail for the specified asset.
Public function Virtual void

Draw ( UObject* Object,
int32 X,
int32 Y,
uint32 Width,
uint32 Height,
FRenderTarget* Viewport,
FCanvas* Canvas,
bool bAdditionalViewFamily
)

 Draws a thumbnail for the object that was specified.
Public function Virtual Const EThumbnailRenderFrequency Override this method to control the render frequency for thumbnails in your editor Generally speaking you should use Realtime if you want an animated thumbnail, but if not it is expensive to use (per-frame draws) If not using realtime, the next best default is OnAssetSave, which updates the thumbnail only save.
Public function Virtual Const void

GetThumbnailSize ( UObject* Object,
float Zoom,
uint32& OutWidth,
uint32& OutHeight
)

 Calculates the size the thumbnail would be at the specified zoom level
Protected function Static FGameTime

GetTime ()

  
Protected function Static void

RenderViewFamily ( FCanvas* Canvas,
FSceneViewFamily* ViewFamily,
FSceneView* View
)

 Renders the thumbnail's view family.

Deprecated Functions

  Type Name Description
Public function Virtual Const bool Please override GetThumbnailRenderFrequency instead, AllowsRealtimeThumbnails is not used.
Public function Virtual void

Draw ( UObject* Object,
int32 X,
int32 Y,
uint32 Width,
uint32 Height,
FRenderTarget* Viewport,
FCanvas* Canvas
)

 Please override the other prototype of the Draw function.
Protected function Static void

RenderViewFamily ( FCanvas* Canvas,
FSceneViewFamily* ViewFamily
)

 Please use the prototype of RenderViewFamily which takes a non-const view in parameter : like the view family the view is still not quite final until SetupView is called.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page