SCR_BasePreviewEntity Class Reference

Inheritance diagram for SCR_BasePreviewEntity:

Protected Member Functions
void	SetPreviewTransform (vector worldTransform[4], EEditorTransformVertical verticalMode, float heightTerrain=0, bool isUnderwater=false, TraceParam trace=null)
void	SetChildTransform (EEditorTransformVertical verticalMode, float heightTerrain, bool isUnderwater=false, TraceParam trace=null)
void	SetPreviewObject (VObject mesh, ResourceName material)
array< SCR_BasePreviewEntity >	GetPreviewChildren ()
IEntity	GetSourceEntity ()
void	GetPreviewBounds (out vector outBoundMin, out vector outBoundMax)
bool	HasMultipleEditableEntities ()
void	EOnPreviewInit (SCR_BasePreviewEntry entry, SCR_BasePreviewEntity root)
void	EOnRootPreviewInit (array< ref SCR_BasePreviewEntry > entries)
void	SCR_BasePreviewEntity (IEntitySource src, IEntity parent)
void	~SCR_BasePreviewEntity ()

Static Protected Member Functions
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)

Protected Attributes
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

Generic preview entity used to represent another entity is simplified form. Uses array of SCR_BasePreviewEntry for configuration. Such array can be generated from prefab or existing entities, see inherited classes for details.

Definition at line 9 of file SCR_BasePreviewEntity.c.

Constructor & Destructor Documentation

SCR_BasePreviewEntity()

void SCR_BasePreviewEntity::SCR_BasePreviewEntity ( IEntitySource src, IEntity parent )

inlineprotected

Definition at line 441 of file SCR_BasePreviewEntity.c.

~SCR_BasePreviewEntity()

void SCR_BasePreviewEntity::~SCR_BasePreviewEntity ( )

inlineprotected

Definition at line 444 of file SCR_BasePreviewEntity.c.

Member Function Documentation

EOnPreviewInit()

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

protected

Init event called when the preview is created. To be overridden by child classes

EOnRootPreviewInit()

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

protected

Init event called on preview root entity. To be overridden by child classes

GetPreviewBounds()

void SCR_BasePreviewEntity::GetPreviewBounds ( out vector outBoundMin, out vector outBoundMax )

inlineprotected

Get local bounding box of the preview entity (including all children)

Parameters

[out]	outBoundMin	Lower corner
[out]	outBoundMax	Upper corner

Definition at line 418 of file SCR_BasePreviewEntity.c.

GetPreviewChildren()

array< SCR_BasePreviewEntity > SCR_BasePreviewEntity::GetPreviewChildren ( )

inlineprotected

Get all direct preview entity children.

Returns

Array of children

Definition at line 401 of file SCR_BasePreviewEntity.c.

GetSourceEntity()

IEntity SCR_BasePreviewEntity::GetSourceEntity ( )

inlineprotected

Get entity from which the preview was copied from.

Returns

Source entity, or null if the preview was not created from an entity

Definition at line 409 of file SCR_BasePreviewEntity.c.

HasMultipleEditableEntities()

bool SCR_BasePreviewEntity::HasMultipleEditableEntities ( )

inlineprotected

Returns

True if the preview entity represents multiple editable entities (e.g., composition with editable children, or editing multiple editable entities at once).

Definition at line 426 of file SCR_BasePreviewEntity.c.

SetChildTransform()

void SCR_BasePreviewEntity::SetChildTransform ( EEditorTransformVertical verticalMode, float heightTerrain, bool isUnderwater = false, TraceParam trace = null )

inlineprotected

Definition at line 298 of file SCR_BasePreviewEntity.c.

SetPreviewObject()

void SCR_BasePreviewEntity::SetPreviewObject ( VObject mesh, ResourceName material )

inlineprotected

Definition at line 382 of file SCR_BasePreviewEntity.c.

SetPreviewTransform()

void SCR_BasePreviewEntity::SetPreviewTransform ( vector worldTransform[4], EEditorTransformVertical verticalMode, float heightTerrain = 0, bool isUnderwater = false, TraceParam trace = null )

inlineprotected

Set transformation of the preview. Entities will be oriented to terrain when when they have the functionality enabled.

Parameters

worldTransform	Transformation matrix in world space
verticalMode	Type of vertical editing
heightTerrain	Height above terrain
isUnderwater	True when the preview entity is under ocean surface

Definition at line 278 of file SCR_BasePreviewEntity.c.

SpawnPreview()

SCR_BasePreviewEntity SCR_BasePreviewEntity::SpawnPreview ( notnull array< ref SCR_BasePreviewEntry > entries, ResourceName previewPrefab, BaseWorld world = null, EntitySpawnParams spawnParams = null, ResourceName material = ResourceName.Empty, EPreviewEntityFlag flags = 0 )

inlinestaticprotected

Spawn preview entity from entries. To get entries, see specialized inherited classes.

Parameters

entries	List of entity entries
previewPrefab	Prefab of preview entity. Can also be a class name, e.g., "SCR_RefPreviewEntity"
world	World in which the preview will be spawned
spawnParams	Spawn params of the preview
material	Material of the preview. When empty, meshes won't be created at all.

Returns

Entity preview

Definition at line 34 of file SCR_BasePreviewEntity.c.

Member Data Documentation

m_aChildren

ref array<SCR_BasePreviewEntity> SCR_BasePreviewEntity::m_aChildren

protected

Definition at line 20 of file SCR_BasePreviewEntity.c.

m_bHasMultipleEditableEntities

bool SCR_BasePreviewEntity::m_bHasMultipleEditableEntities

protected

Definition at line 22 of file SCR_BasePreviewEntity.c.

m_bIsOnOrigTransform

bool SCR_BasePreviewEntity::m_bIsOnOrigTransform = true

protected

Definition at line 17 of file SCR_BasePreviewEntity.c.

m_Entity

IEntity SCR_BasePreviewEntity::m_Entity

protected

Definition at line 14 of file SCR_BasePreviewEntity.c.

m_EntitySource

IEntitySource SCR_BasePreviewEntity::m_EntitySource

protected

Definition at line 15 of file SCR_BasePreviewEntity.c.

m_fHeightTerrain

float SCR_BasePreviewEntity::m_fHeightTerrain = -1

protected

Definition at line 16 of file SCR_BasePreviewEntity.c.

m_Flags

EPreviewEntityFlag SCR_BasePreviewEntity::m_Flags

protected

Definition at line 12 of file SCR_BasePreviewEntity.c.

m_vBounds

vector SCR_BasePreviewEntity::m_vBounds[2]

protected

Definition at line 21 of file SCR_BasePreviewEntity.c.

m_vLocalTransform

vector SCR_BasePreviewEntity::m_vLocalTransform[4]

protected

Definition at line 18 of file SCR_BasePreviewEntity.c.

m_vTerrainTransform

vector SCR_BasePreviewEntity::m_vTerrainTransform[4]

protected

Definition at line 19 of file SCR_BasePreviewEntity.c.

---

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

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