SCR_RefPreviewEntity Interface Reference

Reference entity used to position edited entities according to preview. More...

Inheritance diagram for SCR_RefPreviewEntity:

Public Member Functions
void	ApplyReference (SCR_EditorPreviewParams param)
	Apply changes in reference entity to its original entities.
void	SetAsInstant ()
	Mark the reference entity as applied at the same time as it's created.
Public Member Functions inherited from SCR_EditablePreviewEntity
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 void	SpawnAndApplyReference (SCR_EditableEntityComponent entity, SCR_EditorPreviewParams param)
	Create and apply reference entity used for entity placement once transformation is confirmed.
Static Public Member Functions inherited from SCR_EditablePreviewEntity
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
void	ApplyChild (SCR_EditorPreviewParams param, bool isDirectChild, set< SCR_EditableEntityComponent > editedEntities, bool isInstant)
void	UpdateReference (vector transform[4], EEditorTransformVertical verticalMode, bool isUnderwater)
override void	EOnPreviewInit (SCR_BasePreviewEntry entry, SCR_BasePreviewEntity root)
	Init event called when the preview is created.
Protected Member Functions inherited from SCR_EditablePreviewEntity
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
ref set< SCR_EditableEntityComponent >	m_aEditedEntities
bool	m_bIsInstant
Protected Attributes inherited from SCR_EditablePreviewEntity
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

Reference entity used to position edited entities according to preview.

Member Function Documentation

ApplyChild()

void SCR_RefPreviewEntity.ApplyChild ( SCR_EditorPreviewParams param, bool isDirectChild, set< SCR_EditableEntityComponent > editedEntities, bool isInstant )

protected

ApplyReference()

void SCR_RefPreviewEntity.ApplyReference

(

SCR_EditorPreviewParams

param

)

Apply changes in reference entity to its original entities.

Parameters

[in]

param

Transformation params

EOnPreviewInit()

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

protected

Init event called when the preview is created.

To be overridden by child classes

Implements SCR_EditablePreviewEntity.

SetAsInstant()

void SCR_RefPreviewEntity.SetAsInstant

(

)

Mark the reference entity as applied at the same time as it's created.

SpawnAndApplyReference()

static void SCR_RefPreviewEntity.SpawnAndApplyReference ( SCR_EditableEntityComponent entity, SCR_EditorPreviewParams param )

static

Create and apply reference entity used for entity placement once transformation is confirmed.

Parameters

[in]	entity	Directly edited entity
[in]	param	Transformation params

UpdateReference()

void SCR_RefPreviewEntity.UpdateReference ( vector transform[4], EEditorTransformVertical verticalMode, bool isUnderwater )

protected

Member Data Documentation

m_aEditedEntities

ref set<SCR_EditableEntityComponent> SCR_RefPreviewEntity.m_aEditedEntities

protected

m_bIsInstant

bool SCR_RefPreviewEntity.m_bIsInstant

protected

---

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

• Game/Entities/Preview/SCR_RefPreviewEntity.c