SCR_EditablePreviewEntity Interface Reference

Preview entity created from existing editable entities. More...

Inheritance diagram for SCR_EditablePreviewEntity:

Public Member Functions
SCR_EditableEntityComponent	GetEditableEntity ()
	Get editable entity which this preview entity represents.
array< IEntity >	GetExcludeArray ()
	Get array of entities to be excluded when checking for GEOMETRY intersection for the preview.
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 int	_WB_GetAfterWorldUpdateSpecs (IEntitySource src)
override void	_WB_AfterWorldUpdate (float timeSlice)

Static Public Member Functions
static SCR_BasePreviewEntity	SpawnPreviewFromEditableOwner (IEntity entity, ResourceName previewPrefab, BaseWorld world=null, EntitySpawnParams spawnParams=null, ResourceName material=ResourceName.Empty, EPreviewEntityFlag flags=0)
	Spawn preview entity from existing owner of editable entity.
static SCR_BasePreviewEntity	SpawnPreviewFromEditableEntity (SCR_EditableEntityComponent entity, ResourceName previewPrefab, BaseWorld world=null, EntitySpawnParams spawnParams=null, ResourceName material=ResourceName.Empty, EPreviewEntityFlag flags=0)
	Spawn preview entity from existing editable entity.
static SCR_BasePreviewEntity	SpawnPreviewFromEditableEntities (notnull set< SCR_EditableEntityComponent > entities, ResourceName previewPrefab, BaseWorld world=null, EntitySpawnParams spawnParams=null, ResourceName material=ResourceName.Empty, EPreviewEntityFlag flags=0)
	Spawn preview entity from a set of editable entities.
static array< ref SCR_BasePreviewEntry >	GetPreviewEntriesFromEditableEntity (SCR_EditableEntityComponent entity, out EntitySpawnParams spawnParams=null, EPreviewEntityFlag flags=0)
	Get preview entries from existing editable entity.
static void	GetPreviewEntries (SCR_EditableEntityComponent 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 editable entity.
Static Public Member Functions inherited from SCR_GenericPreviewEntity
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.

Protected Member Functions
override void	EOnPreviewInit (SCR_BasePreviewEntry entry, SCR_BasePreviewEntity root)
	Init event called when the preview is created.
override void	EOnRootPreviewInit (array< ref SCR_BasePreviewEntry > entries)
	Init event called on preview root entity.
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)

Protected Attributes
SCR_EditableEntityComponent	m_EditableEntity
ref array< IEntity >	m_aExcludeArray
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

Additional Inherited Members
Static Protected Member Functions inherited from SCR_GenericPreviewEntity
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])

Detailed Description

Preview entity created from existing editable entities.

Member Function Documentation

EOnPreviewInit()

override void SCR_EditablePreviewEntity.EOnPreviewInit ( SCR_BasePreviewEntry entry, SCR_BasePreviewEntity root )

protected

Init event called when the preview is created.

To be overridden by child classes

Implements SCR_BasePreviewEntity.

Implemented in SCR_RefPreviewEntity.

EOnRootPreviewInit()

override void SCR_EditablePreviewEntity.EOnRootPreviewInit ( array< ref SCR_BasePreviewEntry > entries )

protected

Init event called on preview root entity.

To be overridden by child classes

Implements SCR_BasePreviewEntity.

GetEditableEntity()

SCR_EditableEntityComponent SCR_EditablePreviewEntity.GetEditableEntity

(

)

Get editable entity which this preview entity represents.

Returns

Editable entity

GetExcludeArray()

array< IEntity > SCR_EditablePreviewEntity.GetExcludeArray

(

)

Get array of entities to be excluded when checking for GEOMETRY intersection for the preview.

Returns

Array of entities

GetPreviewEntries()

static void SCR_EditablePreviewEntity.GetPreviewEntries ( SCR_EditableEntityComponent 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 editable entity.

Parameters

	entity	Editable 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

GetPreviewEntriesFromEditableEntity()

static array< ref SCR_BasePreviewEntry > SCR_EditablePreviewEntity.GetPreviewEntriesFromEditableEntity ( SCR_EditableEntityComponent entity, out EntitySpawnParams spawnParams = null, EPreviewEntityFlag flags = 0 )

static

Get preview entries from existing editable entity.

Parameters

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

Returns

Array of configuration entries.

SpawnPreviewFromEditableEntities()

static SCR_BasePreviewEntity SCR_EditablePreviewEntity.SpawnPreviewFromEditableEntities ( notnull set< SCR_EditableEntityComponent > entities, ResourceName previewPrefab, BaseWorld world = null, EntitySpawnParams spawnParams = null, ResourceName material = ResourceName::Empty, EPreviewEntityFlag flags = 0 )

static

Spawn preview entity from a set of editable entities.

Parameters

entities	Set of editable entities
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, transformation defines pivot point of the preview
material	Material of the preview

Returns

Entity preview

SpawnPreviewFromEditableEntity()

static SCR_BasePreviewEntity SCR_EditablePreviewEntity.SpawnPreviewFromEditableEntity ( SCR_EditableEntityComponent entity, ResourceName previewPrefab, BaseWorld world = null, EntitySpawnParams spawnParams = null, ResourceName material = ResourceName::Empty, EPreviewEntityFlag flags = 0 )

static

Spawn preview entity from existing editable entity.

Parameters

entity	Editable 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

SpawnPreviewFromEditableOwner()

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

static

Spawn preview entity from existing owner of editable entity.

Parameters

entity	Owner of editable 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

Member Data Documentation

m_aExcludeArray

ref array<IEntity> SCR_EditablePreviewEntity.m_aExcludeArray

protected

m_EditableEntity

SCR_EditableEntityComponent SCR_EditablePreviewEntity.m_EditableEntity

protected

---

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

• Game/Entities/Preview/SCR_EditablePreviewEntity.c