SCR_PreviewEntityEditorComponent.c

Go to the documentation of this file.

[ComponentEditorProps(category: "GameScripted/Editor", description: "Manager of preview entity. Works only with SCR_EditorBaseEntity!", icon: "WBData/ComponentEditorProps/componentEditor.png")]
class SCR_PreviewEntityEditorComponentClass: SCR_BaseEditorComponentClass
{
};
 
class SCR_PreviewEntityEditorComponent : SCR_BaseEditorComponent
{
    [Attribute(category: "Preview", params: "et", desc: "Default ghost preview entity.")]
    private ResourceName m_PreviewEntityPrefab;
    
    [Attribute(category: "Preview", params: "et", desc: "Ghost preview used when waiting for server callback.")]
    private ResourceName m_WaitingEntityPrefab;
    
    [Attribute(category: "Preview", params: "emat", uiwidget: UIWidgets.ResourcePickerThumbnail, desc: "Preview entity material when confirmation is allowed.")]
    private ResourceName m_PreviewMaterial;
    
    [Attribute(category: "Preview", params: "emat", uiwidget: UIWidgets.ResourcePickerThumbnail, desc: "Preview entity material when confirmation is not allowed.")]
    private ResourceName m_DisabledPreviewMaterial;
    
    [Attribute(category: "Preview", params: "emat", uiwidget: UIWidgets.ResourcePickerThumbnail)]
    private ResourceName m_WaitingPreviewMaterial;
    
    [Attribute(category: "Preview", params: "emat", uiwidget: UIWidgets.ResourcePickerThumbnail)]
    private ResourceName m_WarningPreviewMaterial;
    
    [Attribute(category: "Preview", defvalue: "0.02")]
    private float m_fPreviewTranslationInertia;
    
    [Attribute(category: "Preview", defvalue: "0.05")]
    private float m_fPreviewRotationInertia;
    
    [Attribute(category: "Preview", defvalue: "1 1 1 0.2", desc: "Color of height indicator helper object.")]
    protected ref Color m_HeightIndicatorColor;
 
    [Attribute(category: "Settings", defvalue: EEditorTransformVertical.GEOMETRY.ToString(), uiwidget: UIWidgets.ComboBox, enums: ParamEnumArray.FromEnum(EEditorTransformVertical))]
    private EEditorTransformVertical m_VerticalMode;
 
    [Attribute(category: "Settings", defvalue: SCR_Enum.GetFlagValues(EEditorTransformVertical).ToString(), uiwidget: UIWidgets.Flags, enums: ParamEnumArray.FromEnum(EEditorTransformVertical))]
    private EEditorTransformVertical m_AllowedVerticalModes;
    
    [Attribute(category: "Settings", defvalue: "1")]
    private bool m_bIsVerticalSnap;
    
    [Attribute(category: "Settings", defvalue: "0.25")]
    private float m_fVerticalSnapLimit;
    
    [Attribute(category: "Settings", desc: "When true, interaction between entities passes when at least one edited entity meets the criteria.\nWhen false, all edited entities must be compatible.")]
    private bool m_bORInteraction;
    
    [Attribute(category: "Settings", defvalue: "EditorPreviewContext", desc: "Action context activated all the time.")]
    protected string m_sActionContext;
    
    private vector m_vTransform[4] = {vector.Right, vector.Up, vector.Forward, vector.Zero};
    //private vector m_vTransformBackup[4];
    private EEditorTransformVertical m_VerticalModeReal;
    private SCR_EPreviewState m_LastPreviewState = SCR_EPreviewState.NONE;
    private float m_fHeightTerrain;
    private float m_fHeightSea;
    private bool m_bIsHeightSet;
    private bool m_bIsChange;
    private BaseWorld m_World;
    private bool m_bHasTerrain;
    private SCR_EditableEntityComponent m_Target;
    private bool m_bTargetSnap;
    private bool m_bTargetDelegate;
    private EEditableEntityInteraction m_TargetInteraction;
    private float m_fTargetRotationStep;
    private bool m_bInstantTransformation;
    private bool m_bIsFixedPosition;
    private bool m_bIsRotating;
    private bool m_bIsMovingVertically;
    private bool m_bHasSpecialInteraction;
    private bool m_bIsUnderwater;
    private int m_iHeightIndicatorColor;
    private bool m_bPreviewDisabled;
    protected bool m_bCanMoveInRoot;
    
    protected SCR_LayersEditorComponent m_LayerManager;
    protected SCR_StatesEditorComponent m_StateManager;
    protected SCR_EditablePreviewEntity m_PreviewEntity;
    private ResourceName m_SlotPrefab;
    private vector m_aLocalOffset[4];
    private SCR_EditableEntityComponent m_Entity;
    private EEditableEntityType m_EntityType;
    protected ref SCR_EditableEntityInteraction m_Interaction;
    
    // OnPreviewCreate(SCR_BasePreviewEntity previewEntity)
    private ref ScriptInvoker Event_OnPreviewCreate = new ScriptInvoker;
    // OnPreviewDelete(SCR_BasePreviewEntity previewEntity)
    private ref ScriptInvoker Event_OnPreviewDelete = new ScriptInvoker;
    // OnPreviewChange(vector transform[4], bool isChange)
    private ref ScriptInvoker Event_OnPreviewChange = new ScriptInvoker;
    // OnTargetChange(SCR_EditableEntityComponent target)
    private ref ScriptInvoker Event_OnTargetChange = new ScriptInvoker;
    // OnWaitingPreviewCreate(SCR_BasePreviewEntity previewEntity)
    private ref ScriptInvoker Event_OnWaitingPreviewCreate = new ScriptInvoker;
    // OnVerticalModeChange(EEditorTransformVertical verticalMode)
    private ref ScriptInvoker Event_OnVerticalModeChange = new ScriptInvoker;
    // OnVerticalModeChange(EEditorTransformSnap verticalSnap)
    private ref ScriptInvoker Event_OnVerticalSnapChange = new ScriptInvoker;
    
    protected const float VERTICAL_TRACE_OFFSET = 0.01; //--- Vertical offset of trace start to make sure it does not start inside geometry.
    
    void SetPreviewTransform(vector transform[4], float timeSlice = 1, bool instant = false, EEditorTransformVertical verticalMode = EEditorTransformVertical.TERRAIN)
    {
        if (!m_PreviewEntity || m_bIsFixedPosition)
            return;
        
        //--- When on non-snappable entity, hide the preview, as the interaction may not place the entity where the preview is (e.g., moving a character into vehicle)
        if (m_Target && !m_bTargetSnap)
        {
            ResetPreviewTransform();
            return;
        }
        
        instant = true;
        
        vector cameraTransform[4];
        m_World.GetCurrentCamera(cameraTransform);
        vector cameraPos = cameraTransform[3];
        m_bIsUnderwater = cameraPos[1] < m_World.GetOceanBaseHeight();
        
        if (m_Target && m_bTargetSnap)
        {
            //--- Attached to a target, override input transformation
            vector targetTransform[4];
            if (m_Target.GetTransform(targetTransform))
            {
                switch (true)
                {
                    //--- Disabled rotation
                    case (m_fTargetRotationStep == -1):
                    {
                        transform = targetTransform;
                        break;
                    }
                    //--- Stepped rotation
                    case (m_fTargetRotationStep != 0):
                    {
                        vector targetAngles = Math3D.MatrixToAngles(targetTransform);
                        vector angles = Math3D.MatrixToAngles(transform);
                        angles[0] = targetAngles[0] + Math.Round((angles[0] - targetAngles[0]) / m_fTargetRotationStep) * m_fTargetRotationStep;
                        if (!m_bInstantTransformation && !instant) LerpAngles(m_PreviewEntity.GetAngles(), angles, timeSlice);
                        Math3D.AnglesToMatrix(angles, transform);
                        break;
                    }
                    //--- Free rotation (do not modify incoming dir)
                    default:
                    {
                        if (!m_bInstantTransformation) 
                        {
                            vector angles = Math3D.MatrixToAngles(transform);
                            if (!m_bInstantTransformation && !instant) LerpAngles(m_PreviewEntity.GetAngles(), angles, timeSlice);
                            Math3D.AnglesToMatrix(angles, transform);
                        }
                    }
                }
                transform[3] = targetTransform[3];
                if (!m_bInstantTransformation && !instant) transform[3] = LerpTranslation(m_PreviewEntity.GetOrigin(), transform[3], timeSlice);
                
                Math3D.MatrixMultiply4(transform, m_aLocalOffset, transform); //--- Counter local offset to make sure that preview's center is snapped to slot
                m_PreviewEntity.SetPreviewTransform(transform, verticalMode, m_fHeightTerrain, m_bIsUnderwater);
            }
        }
        else
        {
            //--- Free transformation           
            if (!m_bInstantTransformation && !instant) 
            {
                vector transformCurrent[4];
                m_PreviewEntity.GetWorldTransform(transformCurrent);
                
                float quat[4], quatCurrent[4];
                Math3D.MatrixToQuat(transform, quat);
                Math3D.MatrixToQuat(transformCurrent, quatCurrent);
                Math3D.QuatLerp(quatCurrent, quat, quat, timeSlice);
                Math3D.QuatToMatrix(quat, transform);
                
                transform[3] = LerpTranslation(m_PreviewEntity.GetOrigin(), transform[3], timeSlice);
            }
            
            TraceParam trace;
            if (verticalMode == EEditorTransformVertical.GEOMETRY)
            {
                trace = new TraceParam();
                trace.ExcludeArray = m_PreviewEntity.GetExcludeArray();
                
                //--- When the preview represents a composition, trace surface from camera height, not cursor intersection height, as child entities could be below it.
                if (m_PreviewEntity.HasMultipleEditableEntities())
                {
                    vector matrix[4];
                    m_PreviewEntity.GetWorld().GetCurrentCamera(matrix);
                    trace.Start = matrix[3];
                }
            }
            
            m_PreviewEntity.SetPreviewTransform(transform, verticalMode, m_fHeightTerrain, m_bIsUnderwater, trace);
        }
        
        if (!m_bIsChange)
        {
            m_PreviewEntity.SetFlags(EntityFlags.VISIBLE, true);
        }
        
        m_bIsChange = true;
        m_bInstantTransformation = false;
        m_VerticalModeReal = verticalMode;
        Event_OnPreviewChange.Invoke(transform, true);
        
        //--- Height not defined yet, set it now
        if (!m_bIsHeightSet) SetPreviewHeight(transform[3]);
        
        //--- Placeholder vertical indicator. ToDo: Replace
        float indicatorHeight = m_fHeightTerrain - m_aLocalOffset[3][1];
        if (indicatorHeight > 0.025)
        {
            vector indicatorPos = transform[3] - Vector(0, indicatorHeight * 0.5 + m_aLocalOffset[3][1], 0);
            Shape.CreateCylinder(m_iHeightIndicatorColor, ShapeFlags.TRANSP | ShapeFlags.ONCE | ShapeFlags.NOOUTLINE, indicatorPos, 0.05, indicatorHeight);
            Shape.CreateCylinder(m_iHeightIndicatorColor, ShapeFlags.TRANSP | ShapeFlags.ONCE | ShapeFlags.NOOUTLINE | ShapeFlags.NOZBUFFER, indicatorPos, 0.01, indicatorHeight);
        }
    }
    void ResetPreviewTransform()
    {
        if (!m_PreviewEntity || !m_bIsChange)
            return;
        
        bool isChange = m_bIsChange;
        m_bIsChange = false;
        if (isChange)
        {
            //--- Hide the preview
            m_PreviewEntity.ClearFlags(EntityFlags.VISIBLE, true);
            
            vector transform[4];
            m_PreviewEntity.GetWorldTransform(transform);
            Event_OnPreviewChange.Invoke(transform, m_bIsChange);
        }
    }
    bool GetPreviewTransform(out vector transform[4])
    {
        if (!m_PreviewEntity)
            return false;
        
        m_PreviewEntity.GetWorldTransform(transform);
        return true;
    }
    bool GetPreviewTransformOrigin(out vector transform[4])
    {
        if (!m_PreviewEntity) return false;
        Math3D.MatrixCopy(m_vTransform, transform);
        return true;
    }
    void SetPreviewHeight(vector pos)
    {
        if (!m_PreviewEntity || !m_World) return;
        m_fHeightSea = pos[1];
        
        TraceParam trace;
        if (m_VerticalModeReal == EEditorTransformVertical.GEOMETRY)
        {
            //--- When snapping to ground, offset a bit up so prevent the trace from starting below surface
            pos[1] = pos[1] + VERTICAL_TRACE_OFFSET;
            
            trace = new TraceParam();
            trace.ExcludeArray = m_PreviewEntity.GetExcludeArray();
        }
        
        if (m_bHasTerrain)
            m_fHeightTerrain = pos[1] - SCR_TerrainHelper.GetTerrainY(pos, m_World, !m_bIsUnderwater, trace);
        else
            m_fHeightTerrain = m_fHeightSea;
        
        m_bIsHeightSet = true;
    }
    void ResetPreviewHeight()
    {
        m_fHeightSea = 0;
        m_fHeightTerrain = 0;
    }
    float GetPreviewHeightAboveTerrain()
    {
        return m_fHeightTerrain;
    }
    float GetPreviewHeightAboveSea()
    {
        return m_fHeightSea;
    }
    vector GetLocalOffset()
    {
        return m_aLocalOffset[3];
    }
    void SetVerticalMode(EEditorTransformVertical mode)
    {
        if (mode == m_VerticalMode || !SCR_Enum.HasFlag(m_AllowedVerticalModes, mode))
            return;
        
        m_VerticalMode = mode;
        DiagMenu.SetValue(SCR_DebugMenuID.DEBUGUI_EDITOR_TRANSFORM_VERTICAL_MODE, m_VerticalMode >> 1);
        Event_OnVerticalModeChange.Invoke(m_VerticalMode);
    }
    EEditorTransformVertical GetVerticalMode()
    {
        return m_VerticalMode;
    }
    EEditorTransformVertical GetVerticalModeReal()
    {
        return m_VerticalModeReal;
    }
    void SetVerticalSnap(bool enabled)
    {
        if (enabled == m_bIsVerticalSnap)
            return;
        
        m_bIsVerticalSnap = enabled;
        DiagMenu.SetValue(SCR_DebugMenuID.DEBUGUI_EDITOR_TRANSFORM_VERTICAL_SNAP, m_bIsVerticalSnap);
        Event_OnVerticalSnapChange.Invoke(m_bIsVerticalSnap);
    }
    bool IsVerticalSnap()
    {
        return m_bIsVerticalSnap;
    }
    vector SnapVertically(vector pos)
    {
        float baseSnapHeight = GetSnapBaseHeight(pos, GetVerticalMode());
        float delta = pos[1] - baseSnapHeight;
        if (delta < m_fVerticalSnapLimit)
            pos[1] = baseSnapHeight;
        
        return pos;
    }
    bool IsSnappedVertically()
    {
        if (!m_PreviewEntity)
            return false;
        
        vector pos = m_PreviewEntity.GetTransformAxis(3);
        float baseSnapHeight = GetSnapBaseHeight(pos, GetVerticalMode());
        float delta = pos[1] - baseSnapHeight;
        return Math.AbsFloat(delta) < m_fVerticalSnapLimit;
    }
    bool CanUnsnap(float verticalDelta)
    {
        if (!IsSnappedVertically())
            return false;
        
        if (m_VerticalMode == EEditorTransformVertical.TERRAIN)
        {
            return verticalDelta > 0; //--- Cannot go below terrain
        }
        return false;
    }
    protected float GetSnapBaseHeight(vector pos, EEditorTransformVertical verticalMode)
    {
        switch (verticalMode)
        {
            case EEditorTransformVertical.GEOMETRY:
            case EEditorTransformVertical.TERRAIN:
            {
                TraceParam trace;
                if (verticalMode == EEditorTransformVertical.GEOMETRY)
                {
                    trace = new TraceParam();
                    trace.ExcludeArray = m_PreviewEntity.GetExcludeArray();
                }
                return SCR_TerrainHelper.GetTerrainY(pos, m_World, !m_bIsUnderwater, trace) + m_aLocalOffset[3][1] + VERTICAL_TRACE_OFFSET; //--- Offset a bit to make sure the position is not under surface
            }
        }
        return m_aLocalOffset[3][1];
    }
    bool CanMoveInRoot()
    {
        return m_bCanMoveInRoot;
    }
    void ShowAsDisabled(bool disable = true)
    {
        if (disable == m_bPreviewDisabled)
            return;
        
        m_bPreviewDisabled = disable;
        
        ResourceName material = m_PreviewMaterial;
        if (disable)
            material = m_DisabledPreviewMaterial;
        
        SCR_Global.SetMaterial(m_PreviewEntity, material);
    }
    
    void SetPreviewState(SCR_EPreviewState state)
    {
        if (m_LastPreviewState == state)
            return;
        
        ResourceName material;
        switch (state)
        {
            case SCR_EPreviewState.PLACEABLE:
            {
                material = m_PreviewMaterial;
                m_LastPreviewState = SCR_EPreviewState.PLACEABLE;
                break;
            }
            case SCR_EPreviewState.BLOCKED:
            {
                material = m_DisabledPreviewMaterial;
                m_LastPreviewState = SCR_EPreviewState.BLOCKED;
                break;
            }
            case SCR_EPreviewState.WARNING:
            {
                material = m_WarningPreviewMaterial;
                m_LastPreviewState = SCR_EPreviewState.WARNING;
                break;
            }
        }   
        
        SCR_Global.SetMaterial(m_PreviewEntity, material);
    }
 
    void SetLastPreviewState(SCR_EPreviewState state)
    {
        m_LastPreviewState = state;
    }
    
    bool SetTarget(SCR_EditableEntityComponent target, bool isDelegate = false)
    {
        if (!m_PreviewEntity)
            return false;
        
        if (target)
        {
            if (target == m_Target && isDelegate == m_bTargetDelegate)
                return false;
            
            //--- Check if the preview can interact with the target
            bool targetSnap;
            EEditableEntityInteraction targetInteraction;
            if (!CanInteractWith(target, targetSnap, targetInteraction, isDelegate))
            {
                if (m_Target) SetTarget(null);
                return true;
            }
            
            m_Target = target;
            m_bTargetSnap = targetSnap;
            m_TargetInteraction = targetInteraction;
            m_bTargetDelegate = isDelegate;
            
            if (m_bTargetSnap)
            {               
                SCR_SiteSlotEntity slotEntity = SCR_SiteSlotEntity.Cast(target.GetOwner());
                if (slotEntity)
                    m_fTargetRotationStep = slotEntity.GetRotationStep();
                else
                    m_fTargetRotationStep = -1;
            }
        }
        else
        {
            //--- Remove
            if (!m_Target) return false;
            
            m_Target = null;
            m_TargetInteraction = 0;
        }
        Event_OnTargetChange.Invoke(target);
        return true;
    }
    protected bool CanInteractWith(SCR_EditableEntityComponent target, out bool snap, out EEditableEntityInteraction interaction, bool isDelegate)
    {
        //--- Cannot interact with itself
        if (target == m_Entity)
            return false;
        
        //--- Snap to compatible slot
        if (target.HasEntityState(EEditableEntityState.COMPATIBLE_SLOT))
        {
            interaction = EEditableEntityInteraction.SLOT;
            snap = true;
            return true;
        }
        
        bool isTargetDestroyed = target.IsDestroyed();
        
        EEditableEntityInteractionFlag defaultInteractionFlags;
        if (m_LayerManager && m_LayerManager.IsEditingLayersEnabled())
            defaultInteractionFlags |= EEditableEntityInteractionFlag.LAYER_EDITING;
 
        //--- Check interaction of all edited entities
        SCR_EditableEntityCore core = SCR_EditableEntityCore.Cast(SCR_EditableEntityCore.GetInstance(SCR_EditableEntityCore));
        //SCR_EditablePreviewEntity editableChild;
        SCR_EditableEntityComponent editableChild;
        if (core)
        {
            if (m_bORInteraction)
            {
                //--- At least one entity must be compatible
                foreach (SCR_BasePreviewEntity child: m_PreviewEntity.GetPreviewChildren())
                {
                    if (!m_Interaction)
                        continue;
                    
                    EEditableEntityInteractionFlag interactionFlags = defaultInteractionFlags;
                    
                    editableChild = SCR_EditableEntityComponent.GetEditableEntity(child.GetSourceEntity());
                    if (!isTargetDestroyed && (!editableChild || !editableChild.IsDestroyed()))
                        interactionFlags |= EEditableEntityInteractionFlag.ALIVE;
                    
                    if (isDelegate)
                        interactionFlags |= EEditableEntityInteractionFlag.DELEGATE;
                    
                    if (!editableChild || editableChild.GetPlayerID() == 0)
                        interactionFlags |= EEditableEntityInteractionFlag.NON_PLAYABLE;
                    
                    if (m_StateManager && m_StateManager.GetState() == EEditorState.PLACING)
                        interactionFlags |= EEditableEntityInteractionFlag.PLACING;
                    
                    if (m_Interaction.CanSetParent(target, interactionFlags))
                    {
                        interaction = EEditableEntityInteraction.LAYER;
                        return true;
                    }
                }
            }
            else
            {
                //--- All entities must be compatible
                foreach (SCR_BasePreviewEntity child: m_PreviewEntity.GetPreviewChildren())
                {
                    if (!m_Interaction)
                        return false;
                    
                    EEditableEntityInteractionFlag interactionFlags = defaultInteractionFlags;
                    
                    editableChild = SCR_EditableEntityComponent.GetEditableEntity(child.GetSourceEntity());
                    if (!isTargetDestroyed && (!editableChild || !editableChild.IsDestroyed()))
                        interactionFlags |= EEditableEntityInteractionFlag.ALIVE;
                    
                    if (isDelegate)
                        interactionFlags |= EEditableEntityInteractionFlag.DELEGATE;
                    
                    if (!editableChild || editableChild.GetPlayerID() == 0)
                        interactionFlags |= EEditableEntityInteractionFlag.NON_PLAYABLE;
                    
                    if (m_StateManager && m_StateManager.GetState() == EEditorState.PLACING)
                        interactionFlags |= EEditableEntityInteractionFlag.PLACING;
                    
                    if (!m_Interaction.CanSetParent(target, interactionFlags))
                        return false;
                }
                interaction = EEditableEntityInteraction.LAYER;
                return true;
            }
        }
        return false;
    }
    
    SCR_EditableEntityComponent GetTarget()
    {
        return m_Target;
    }
    EEditableEntityInteraction GetTargetInteraction()
    {
        return m_TargetInteraction;
    }
    bool IsSnappedToTarget()
    {
        return m_bTargetSnap;
    }
    SCR_EditablePreviewEntity GetPreviewEntity()
    {
        return m_PreviewEntity;
    }
    string GetActionContext()
    {
        return m_sActionContext;
    }
    bool IsEditing()
    {
        return m_PreviewEntity != null;
    }
    bool IsChange()
    {
        return m_bIsChange || m_bIsFixedPosition || m_Target;
    }
    bool IsRotating()
    {
        return m_bIsRotating;
    }
    bool IsFixedPosition()
    {
        return m_bIsFixedPosition;
    }
    ResourceName GetSlotPrefab()
    {
        return m_SlotPrefab;
    }
    void SetIsMovingVertically(bool isMovingVertically)
    {
        m_bIsMovingVertically = isMovingVertically;
    }
    bool IsMovingVertically()
    {
        return m_bIsMovingVertically;
    }
    void SetIsRotating(bool isRotating)
    {
        m_bIsRotating = isRotating;
    }
    bool IsUnderwater()
    {
        return m_bIsUnderwater;
    }
    array<IEntity> GetExcludeArray()
    {
        if (m_PreviewEntity)
            return m_PreviewEntity.GetExcludeArray();
        else
            return null;
    }
    ScriptInvoker GetOnPreviewCreate()
    {
        return Event_OnPreviewCreate;
    }
    ScriptInvoker GetOnPreviewDelete()
    {
        return Event_OnPreviewDelete;
    }
    ScriptInvoker GetOnPreviewChange()
    {
        return Event_OnPreviewChange;
    }
    ScriptInvoker GetOnTargetChange()
    {
        return Event_OnTargetChange;
    }
    ScriptInvoker GetOnWaitingPreviewCreate()
    {
        return Event_OnWaitingPreviewCreate;
    }
    ScriptInvoker GetOnVerticalModeChange()
    {
        return Event_OnVerticalModeChange;
    }
    ScriptInvoker GetOnVerticalSnapChange()
    {
        return Event_OnVerticalSnapChange;
    }
    
    void InitTransform(vector transform[4])
    {
        m_vTransform = transform;
        
        //--- Normalize transformation matrix, so it does not affect scale even when pivot entity is scaled up or down
        Math3D.MatrixNormalize(m_vTransform);
        
        SetPreviewHeight(transform[3]);
    }
    
    SCR_BasePreviewEntity CreatePreview(SCR_EditableEntityComponent pivot, set<SCR_EditableEntityComponent> entities)
    {
        DeletePreview();
        
        EPreviewEntityFlag flags;
        if (m_bIsUnderwater)
            flags |= EPreviewEntityFlag.UNDERWATER;
        
        if (m_VerticalMode == EEditorTransformVertical.GEOMETRY)
            flags |= EPreviewEntityFlag.GEOMETRY;
        
        EntitySpawnParams spawnParams = new EntitySpawnParams();
        Math3D.MatrixCopy(m_vTransform, spawnParams.Transform);
        m_PreviewEntity = SCR_EditablePreviewEntity.Cast(SCR_EditablePreviewEntity.SpawnPreviewFromEditableEntities(entities, m_PreviewEntityPrefab, GetOwner().GetWorld(), spawnParams, m_PreviewMaterial, flags));
        m_bInstantTransformation = true;
        m_Entity = pivot;
        m_EntityType = pivot.GetEntityType();
        m_Interaction = pivot.GetEntityInteraction();
        m_bCanMoveInRoot = !m_Interaction || m_Interaction.CanSetParent(SCR_EditableEntityInteraction.ROOT, 0);
        
        SCR_EditableEntityUIInfo info = SCR_EditableEntityUIInfo.Cast(pivot.GetInfo());
        if (info)
            m_SlotPrefab = info.GetSlotPrefab();
        else
            m_SlotPrefab = ResourceName.Empty;
        
        //--- Get local offset for slotting
        vector localOffsetPos = m_aLocalOffset[3];
        if (pivot.GetPos(localOffsetPos))
        {
            vector pivotTransform[4];
            pivot.GetOwner().GetWorldTransform(pivotTransform);
            Math3D.MatrixInvMultiply4(m_vTransform, pivotTransform, pivotTransform);
            m_aLocalOffset[3] = -pivotTransform[3];// pivot.GetOwner().CoordToLocal(m_vTransform[3]); //--- Cannot use CoordToLocal, doesn't take m_vTransform rotation into effect
        }
        
        Event_OnPreviewCreate.Invoke(m_PreviewEntity);
        
        //--- Reset position. Without it, moving entity vertically on client (where there's a delay) would cause vertical offset
        SetPreviewHeight(m_vTransform[3]);
        ResetPreviewTransform();
        
        return m_PreviewEntity;
    }
    SCR_BasePreviewEntity CreatePreview(ResourceName prefab, notnull array<vector> offsets, vector initTransform[4] = {})
    {       
        DeletePreview();
        
        if (prefab)
        {
            Resource prefabResource = Resource.Load(prefab);
            EntitySpawnParams spawnParams = new EntitySpawnParams();;
            
            IEntitySource entitySource = SCR_BaseContainerTools.FindEntitySource(prefabResource);
            IEntityComponentSource entityComponent = SCR_BaseContainerTools.FindComponentSource(entitySource, SCR_EditableEntityComponent);
            m_EntityType = SCR_EditableEntityComponentClass.GetEntityType(entityComponent);
            m_Interaction = SCR_EditableEntityComponentClass.GetEntityInteraction(entityComponent);
            m_SlotPrefab = SCR_EditableEntityComponentClass.GetSlotPrefab(entityComponent);
            m_bIsFixedPosition = SCR_EditableEntityComponentClass.HasFlag(entityComponent, EEditableEntityFlag.STATIC_POSITION);
            m_bCanMoveInRoot = !m_Interaction || m_Interaction.CanSetParent(SCR_EditableEntityInteraction.ROOT, 0);
            
            if (m_bIsFixedPosition)
            {
                //--- Get coordinates of the prefab itself when it's intended only for one position
                vector coords;
                entitySource.Get("coords", coords);
                if (coords.LengthSq() != 0)
                {
                    spawnParams.Transform[3] = coords;
                }
                else
                {
                    Print(string.Format("Prefab '%1' is flagged as STATIC_POSITION, but its position is <0,0,0>!", prefab.GetPath()), LogLevel.WARNING);
                    m_bIsFixedPosition = false;
                }
            }
            else if (initTransform[3] == vector.Zero)
            {
                //--- Restore previous yaw (don't apply full rotation, would cause problems on uneven terrain; ToDo: Use rotation relativer to terrain?)
                vector angles = Vector(Math3D.MatrixToAngles(m_vTransform)[0], 0, 0);
                Math3D.AnglesToMatrix(angles, m_vTransform);
                m_vTransform[3] = vector.Zero; //--- Reset position to prevent waypoint appearing in the air
                spawnParams.Transform = m_vTransform;
            }
            else
            {
                spawnParams.Transform = initTransform;
            }
            
            if (offsets.Count() > 1)
            {
                //--- Create as many previews as there are selected entities (e.g., for waypoins or tasks)
                array<ref SCR_BasePreviewEntry> entries = SCR_PrefabPreviewEntity.GetPreviewEntriesFromPrefab(prefabResource);
                SCR_BasePreviewEntry sourceEntry = entries[0];
                SCR_BasePreviewEntry entry;
                for (int i = 0, count = offsets.Count(); i < count; i++)
                {
                    if (i == 0)
                    {
                        entry = entries[i];
                    }
                    else
                    {
                        entry = new SCR_BasePreviewEntry();
                        entry.CopyFrom(sourceEntry);
                        entries.Insert(entry);
                    }
                    entry.m_vPosition = offsets[i];
                }
                m_PreviewEntity = SCR_EditablePreviewEntity.Cast(SCR_PrefabPreviewEntity.SpawnPreview(entries, m_PreviewEntityPrefab, spawnParams: spawnParams, material: m_PreviewMaterial));
            }
            else
            {
                //--- Create preview directly
                m_PreviewEntity = SCR_EditablePreviewEntity.Cast(SCR_PrefabPreviewEntity.SpawnPreviewFromPrefab(prefabResource, m_PreviewEntityPrefab, spawnParams: spawnParams, material: m_PreviewMaterial));
            }
            if (m_PreviewEntity)
            {
                m_fHeightTerrain = 0;               
                Event_OnPreviewCreate.Invoke(m_PreviewEntity);
            }
        }
        return m_PreviewEntity;
    }
    void DeletePreview()
    {
        if (m_PreviewEntity)
        {
            SCR_BasePreviewEntity previewEntity = m_PreviewEntity;
            m_PreviewEntity = null;
            
            previewEntity.GetWorldTransform(m_vTransform);
            if (m_Target)
                Event_OnTargetChange.Invoke(null);
            
            Event_OnPreviewDelete.Invoke(previewEntity);
            delete previewEntity;
        }
        m_bIsChange = false;
        m_bIsHeightSet = false;
        m_bIsFixedPosition = false;
        m_bIsRotating = false;
        m_bPreviewDisabled = false;
        m_Target = null;
        m_TargetInteraction = 0;
        m_Entity = null;
        m_aLocalOffset[3] = vector.Zero;
    }
    SCR_BasePreviewEntity CreateWaitingPreview()
    {
        if (!m_PreviewEntity)
            return null;
        
        Resource previewResource = Resource.Load(m_WaitingEntityPrefab);
        if (!previewResource || !previewResource.IsValid()) 
            return null;
        
        EntitySpawnParams spawnParams = new EntitySpawnParams();
        m_PreviewEntity.GetWorldTransform(spawnParams.Transform);
        SCR_BasePreviewEntity previewEntity = SCR_EditablePreviewEntity.SpawnPreviewFromEditableOwner(m_PreviewEntity, m_WaitingEntityPrefab, m_PreviewEntity.GetWorld(), spawnParams, m_WaitingPreviewMaterial);
        Event_OnWaitingPreviewCreate.Invoke(previewEntity);
        return previewEntity;
    }
    
    protected vector LerpTranslation(vector currentPos, vector targetPos, float timeSlice)
    {
        return vector.Lerp(currentPos, targetPos, Math.Min(timeSlice * m_fPreviewTranslationInertia, 1));
    }
    protected void LerpAngles(vector currentAngles, out vector targetAngles, float timeSlice)
    {
        //--- currentAngles vector has different order than targetAngles vector, because it's filled by GetAngles()
        targetAngles[0] = SCR_Math.LerpAngle(currentAngles[1], targetAngles[0], Math.Min(timeSlice * m_fPreviewRotationInertia, 1));
    }
    
    protected void OnUserSettingsChanged()
    {
        BaseContainer editorSettings = GetGame().GetGameUserSettings().GetModule("SCR_EditorSettings");
        if (!editorSettings)
            return;
        
        int value;
        editorSettings.Get("m_PreviewVerticalSnap", value);
        SetVerticalSnap(value);
        editorSettings.Get("m_PreviewVerticleMode", value);
        SetVerticalMode(value);
    }
    
    
    override void EOnEditorDebug(array<string> debugTexts)
    {
        debugTexts.Insert("Vertical Mode: " + Type().EnumToString(EEditorTransformVertical, m_VerticalMode));
        debugTexts.Insert("Vertical Mode (Real): " + Type().EnumToString(EEditorTransformVertical, m_VerticalModeReal));
        debugTexts.Insert("Vertical Snap: " + m_bIsVerticalSnap);
        debugTexts.Insert("Height ASL: " + m_fHeightSea);
        debugTexts.Insert("Height ATL: " + m_fHeightTerrain);
        
        if (m_PreviewEntity)
        {
            debugTexts.Insert(string.Format("Preview Target: %1", m_Target));
            debugTexts.Insert(string.Format("Preview Target Interaction: %1", typename.EnumToString(EEditableEntityInteraction, m_TargetInteraction)));
        }
    }
    override void EOnFrame(IEntity owner, float timeSlice)
    {
#ifdef ENABLE_DIAG
        int verticalMode = 1 << DiagMenu.GetValue(SCR_DebugMenuID.DEBUGUI_EDITOR_TRANSFORM_VERTICAL_MODE);
        if (verticalMode != m_VerticalMode)
        {
            SetVerticalMode(verticalMode);
        }
        if (DiagMenu.GetValue(SCR_DebugMenuID.DEBUGUI_EDITOR_TRANSFORM_VERTICAL_SNAP) != m_bIsVerticalSnap)
        {
            SetVerticalSnap(DiagMenu.GetValue(SCR_DebugMenuID.DEBUGUI_EDITOR_TRANSFORM_VERTICAL_SNAP));
        }
#endif
    }
    override void EOnEditorActivate()
    {
        SetEventMask(GetOwner(), EntityEvent.FRAME);
 
        ArmaReforgerScripted game = GetGame();
        if (!game) return;
        
        m_World = game.GetWorld();
        m_LayerManager = SCR_LayersEditorComponent.Cast(SCR_LayersEditorComponent.GetInstance(SCR_LayersEditorComponent));
        m_StateManager = SCR_StatesEditorComponent.Cast(SCR_StatesEditorComponent.GetInstance(SCR_StatesEditorComponent));
        
#ifdef ENABLE_DIAG
        typename enumVerticalMode = EEditorTransformVertical;
        DiagMenu.RegisterRange(SCR_DebugMenuID.DEBUGUI_EDITOR_TRANSFORM_VERTICAL_MODE, "", "Vertical Mode", "Transforming", string.Format("0 %1 0 1", enumVerticalMode.GetVariableCount() - 1));
        DiagMenu.SetValue(SCR_DebugMenuID.DEBUGUI_EDITOR_TRANSFORM_VERTICAL_MODE, m_VerticalMode >> 1);
        
        DiagMenu.RegisterBool(SCR_DebugMenuID.DEBUGUI_EDITOR_TRANSFORM_VERTICAL_SNAP, "", "Vertical Snap", "Transforming");
        DiagMenu.SetValue(SCR_DebugMenuID.DEBUGUI_EDITOR_TRANSFORM_VERTICAL_SNAP, m_bIsVerticalSnap);
#endif
    }
    override void EOnEditorDeactivate()
    {
        DeletePreview();
    }
    override void EOnEditorInit()
    {
        ArmaReforgerScripted game = GetGame();
        if (!game) 
            return;
        
        GenericWorldEntity worldEntity = game.GetWorldEntity();
        if (!worldEntity) 
            return;
        
        m_bHasTerrain = worldEntity.GetTerrain(0, 0) != null;
        
        m_fPreviewTranslationInertia = 1 / Math.Max(m_fPreviewTranslationInertia, 0.001);
        m_fPreviewRotationInertia = 1 / Math.Max(m_fPreviewRotationInertia, 0.001);
        
        BaseContainer editorSettings = GetGame().GetGameUserSettings().GetModule("SCR_EditorSettings");
        if (editorSettings)
        {
            //Init values from options
            OnUserSettingsChanged();
            GetGame().OnUserSettingsChangedInvoker().Insert(OnUserSettingsChanged);
        }
        
        m_iHeightIndicatorColor = m_HeightIndicatorColor.PackToInt();
        
        Math3D.MatrixIdentity3(m_aLocalOffset); //--- Initialize offset matrix angles
    }
    
    override void OnDelete(IEntity owner)
    {
        if (GetGame())
            GetGame().OnUserSettingsChangedInvoker().Remove(OnUserSettingsChanged);
    }
};
 
enum SCR_EPreviewState
{
    NONE, 
    PLACEABLE, 
    BLOCKED, 
    WARNING 
};