SCR_GenericPreviewEntity Interface Reference

Preview entity created from existing entities. More...

Inheritance diagram for SCR_GenericPreviewEntity:

Static Public Member Functions
static SCR_BasePreviewEntity	SpawnPreviewFromEntity (IEntity entity, ResourceName previewPrefab, BaseWorld world=null, EntitySpawnParams spawnParams=null, ResourceName material=ResourceName.Empty, EPreviewEntityFlag flags=0)
	Spawn preview entity from existing entity.
static array< ref SCR_BasePreviewEntry >	GetPreviewEntriesFromEntity (IEntity entity, out EntitySpawnParams spawnParams=null, EPreviewEntityFlag flags=0)
	Get preview entries from existing entity.
static void	GetPreviewEntries (IEntity entity, out notnull array< ref SCR_BasePreviewEntry > outEntries, out vector rootTransform[4], int parentID=-1, EPreviewEntityFlag flags=0, TraceParam trace=null)
	Get preview entries from existing entity.
Static Public Member Functions inherited from SCR_BasePreviewEntity
static SCR_BasePreviewEntity	SpawnPreview (notnull array< ref SCR_BasePreviewEntry > entries, ResourceName previewPrefab, BaseWorld world=null, EntitySpawnParams spawnParams=null, ResourceName material=ResourceName.Empty, EPreviewEntityFlag flags=0)
	Spawn preview entity from entries.

Static Protected Member Functions
static float	GetLocalScale (IEntity entity)
static string	GetPivotName (IEntity entity)
static bool	GetMesh (IEntity entity, EPreviewEntityFlag flags, SCR_BasePreviewEntry entry, out notnull array< ref SCR_BasePreviewEntry > outEntries)
static void	SaveTerrainTransform (IEntity entity, SCR_BasePreviewEntry entry, bool isUnderwater=false, TraceParam trace=null)
static void	SaveRootTransform (out vector transform[4], out vector rootTransform[4])

Additional Inherited Members
Public Member Functions inherited from SCR_BasePreviewEntity
void	SetPreviewTransform (vector worldTransform[4], EEditorTransformVertical verticalMode, float heightTerrain=0, bool isUnderwater=false, TraceParam trace=null)
	Set transformation of the preview.
array< SCR_BasePreviewEntity >	GetPreviewChildren ()
	Get all direct preview entity children.
IEntity	GetSourceEntity ()
	Get entity from which the preview was copied from.
void	GetPreviewBounds (out vector outBoundMin, out vector outBoundMax)
	Get local bounding box of the preview entity (including all children)
bool	HasMultipleEditableEntities ()
void	SCR_BasePreviewEntity (IEntitySource src, IEntity parent)
void	~SCR_BasePreviewEntity ()
override void	_WB_GetBoundBox (inout vector min, inout vector max, IEntitySource src)
override void	_WB_AfterWorldUpdate (float timeSlice)
Protected Member Functions inherited from SCR_BasePreviewEntity
void	SetChildTransform (EEditorTransformVertical verticalMode, float heightTerrain, bool isUnderwater=false, TraceParam trace=null)
void	SetPreviewObject (VObject mesh, ResourceName material)
void	EOnPreviewInit (SCR_BasePreviewEntry entry, SCR_BasePreviewEntity root)
	Init event called when the preview is created.
void	EOnRootPreviewInit (array< ref SCR_BasePreviewEntry > entries)
	Init event called on preview root entity.
Protected Attributes inherited from SCR_BasePreviewEntity
EPreviewEntityFlag	m_Flags
IEntity	m_Entity
IEntitySource	m_EntitySource
float	m_fHeightTerrain = -1
bool	m_bIsOnOrigTransform = true
vector	m_vLocalTransform [4]
vector	m_vTerrainTransform [4]
ref array< SCR_BasePreviewEntity >	m_aChildren
vector	m_vBounds [2]
bool	m_bHasMultipleEditableEntities

Detailed Description

Preview entity created from existing entities.

Member Function Documentation

GetLocalScale()

static float SCR_GenericPreviewEntity.GetLocalScale ( IEntity  entity )

staticprotected

GetMesh()

static bool SCR_GenericPreviewEntity.GetMesh ( IEntity  entity, EPreviewEntityFlag  flags, SCR_BasePreviewEntry  entry, out notnull array< ref SCR_BasePreviewEntry >  outEntries  )

staticprotected

GetPivotName()

static string SCR_GenericPreviewEntity.GetPivotName ( IEntity  entity )

staticprotected

GetPreviewEntries()

static void SCR_GenericPreviewEntity.GetPreviewEntries ( IEntity  entity, out notnull array< ref SCR_BasePreviewEntry >  outEntries, out vector  rootTransform[4], int  parentID = -1, EPreviewEntityFlag  flags = 0, TraceParam  trace = null  )

static

Get preview entries from existing entity.

Parameters

	entity	Entity
[out]	outEntries	Array to be filled with entity entries
[out]	rootTransform	Center pivot of the preview. When zero, transformation of the first entity will be used

GetPreviewEntriesFromEntity()

static array< ref SCR_BasePreviewEntry > SCR_GenericPreviewEntity.GetPreviewEntriesFromEntity ( IEntity  entity, out EntitySpawnParams  spawnParams = null, EPreviewEntityFlag  flags = 0  )

static

Get preview entries from existing entity.

Parameters

	entity	Entity
	spawnParams	Spawn params of the preview
[out]	outEntries	Array filled with preview entries

Returns

Array of configuration entries.

SaveRootTransform()

static void SCR_GenericPreviewEntity.SaveRootTransform ( out vector  transform[4], out vector  rootTransform[4]  )

staticprotected

SaveTerrainTransform()

static void SCR_GenericPreviewEntity.SaveTerrainTransform ( IEntity  entity, SCR_BasePreviewEntry  entry, bool  isUnderwater = false, TraceParam  trace = null  )

staticprotected

SpawnPreviewFromEntity()

static SCR_BasePreviewEntity SCR_GenericPreviewEntity.SpawnPreviewFromEntity ( IEntity  entity, ResourceName  previewPrefab, BaseWorld  world = null, EntitySpawnParams  spawnParams = null, ResourceName  material = ResourceName::Empty, EPreviewEntityFlag  flags = 0  )

static

Spawn preview entity from existing entity.

Parameters

entity	Entity
previewPrefab	Prefab from which the preview entity will be spawned from. Apart from file path, it can be also class name
world	World in which the preview will be spawned
spawnParams	Spawn params of the preview
material	Material of the preview

Returns

Entity preview

---

The documentation for this interface was generated from the following file:

• Game/Entities/Preview/SCR_GenericPreviewEntity.c