SCR_EditablePreviewEntity Class Reference

Inheritance diagram for SCR_EditablePreviewEntity:

Protected Member Functions
SCR_EditableEntityComponent	GetEditableEntity ()
array< IEntity >	GetExcludeArray ()
override void	EOnPreviewInit (SCR_BasePreviewEntry entry, SCR_BasePreviewEntity root)
void	EOnRootPreviewInit (array< ref SCR_BasePreviewEntry > entries)

Static Protected Member Functions
static SCR_BasePreviewEntity	SpawnPreviewFromEditableOwner (IEntity entity, ResourceName previewPrefab, BaseWorld world=null, EntitySpawnParams spawnParams=null, ResourceName material=ResourceName.Empty, EPreviewEntityFlag flags=0)
static SCR_BasePreviewEntity	SpawnPreviewFromEditableEntity (SCR_EditableEntityComponent entity, ResourceName previewPrefab, BaseWorld world=null, EntitySpawnParams spawnParams=null, ResourceName material=ResourceName.Empty, EPreviewEntityFlag flags=0)
static SCR_BasePreviewEntity	SpawnPreviewFromEditableEntities (notnull set< SCR_EditableEntityComponent > entities, ResourceName previewPrefab, BaseWorld world=null, EntitySpawnParams spawnParams=null, ResourceName material=ResourceName.Empty, EPreviewEntityFlag flags=0)
static array< ref SCR_BasePreviewEntry >	GetPreviewEntriesFromEditableEntity (SCR_EditableEntityComponent entity, out EntitySpawnParams spawnParams=null, EPreviewEntityFlag flags=0)
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)

Protected Attributes
SCR_EditableEntityComponent	m_EditableEntity
ref array< IEntity >	m_aExcludeArray

Detailed Description

Preview entity created from existing editable entities.

Definition at line 8 of file SCR_EditablePreviewEntity.c.

Member Function Documentation

EOnPreviewInit()

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

inlineprotected

Definition at line 242 of file SCR_EditablePreviewEntity.c.

EOnRootPreviewInit()

void SCR_EditablePreviewEntity::EOnRootPreviewInit ( array< ref SCR_BasePreviewEntry > entries )

inlineprotected

Definition at line 260 of file SCR_EditablePreviewEntity.c.

GetEditableEntity()

SCR_EditableEntityComponent SCR_EditablePreviewEntity::GetEditableEntity ( )

inlineprotected

Get editable entity which this preview entity represents.

Returns

Editable entity

Definition at line 229 of file SCR_EditablePreviewEntity.c.

GetExcludeArray()

array< IEntity > SCR_EditablePreviewEntity::GetExcludeArray ( )

inlineprotected

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

Returns

Array of entities

Definition at line 237 of file SCR_EditablePreviewEntity.c.

GetPreviewEntries()

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 )

inlinestaticprotected

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

Definition at line 126 of file SCR_EditablePreviewEntity.c.

GetPreviewEntriesFromEditableEntity()

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

inlinestaticprotected

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.

Definition at line 106 of file SCR_EditablePreviewEntity.c.

SpawnPreviewFromEditableEntities()

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 )

inlinestaticprotected

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

Definition at line 58 of file SCR_EditablePreviewEntity.c.

SpawnPreviewFromEditableEntity()

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

inlinestaticprotected

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

Definition at line 39 of file SCR_EditablePreviewEntity.c.

SpawnPreviewFromEditableOwner()

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

inlinestaticprotected

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

Definition at line 22 of file SCR_EditablePreviewEntity.c.

Member Data Documentation

m_aExcludeArray

ref array<IEntity> SCR_EditablePreviewEntity::m_aExcludeArray

protected

Definition at line 11 of file SCR_EditablePreviewEntity.c.

m_EditableEntity

SCR_EditableEntityComponent SCR_EditablePreviewEntity::m_EditableEntity

protected

Definition at line 10 of file SCR_EditablePreviewEntity.c.

---

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

• scripts/Game/Entities/Preview/SCR_EditablePreviewEntity.c