Hex Terrains Framework
Search Results for

    Show / Hide Table of Contents

    Class CalcCellMetricsSystem<TSurface>

    Base class for systems that calculate cell metrics for provided surface (TSurface)

    Inheritance
    object
    ComponentSystemBase
    SystemBase
    CalcCellMetricsSystem<TSurface>
    CalcGroundCellMetricsSystem
    CalcWaterCellMetricsSystem
    Inherited Members
    SystemBase.Dependency
    SystemBase.CheckedStateRef
    SystemBase.CompleteDependency()
    SystemBase.Entities
    SystemBase.Job
    SystemBase.Update()
    SystemBase.OnUpdate()
    SystemBase.GetComponent<T>(Entity)
    SystemBase.SetComponent<T>(Entity, T)
    SystemBase.HasComponent<T>(Entity)
    SystemBase.HasBuffer<T>(Entity)
    SystemBase.GetComponentLookup<T>(bool)
    SystemBase.GetComponentDataFromEntity<T>(bool)
    SystemBase.GetBuffer<T>(Entity, bool)
    SystemBase.GetBufferLookup<T>(bool)
    SystemBase.GetBufferFromEntity<T>(bool)
    SystemBase.GetEntityStorageInfoLookup()
    SystemBase.GetStorageInfoFromEntity()
    SystemBase.Exists(Entity)
    ComponentSystemBase.Enabled
    ComponentSystemBase.EntityQueries
    ComponentSystemBase.GlobalSystemVersion
    ComponentSystemBase.LastSystemVersion
    ComponentSystemBase.EntityManager
    ComponentSystemBase.World
    ComponentSystemBase.SystemHandle
    ComponentSystemBase.SystemHandleUntyped
    ComponentSystemBase.Time
    ComponentSystemBase.WorldUpdateAllocator
    ComponentSystemBase.OnCreate()
    ComponentSystemBase.OnStartRunning()
    ComponentSystemBase.OnStopRunning()
    ComponentSystemBase.OnDestroy()
    ComponentSystemBase.ShouldRunSystem()
    ComponentSystemBase.GetComponentTypeHandle<T>(bool)
    ComponentSystemBase.GetDynamicComponentTypeHandle(ComponentType)
    ComponentSystemBase.GetBufferTypeHandle<T>(bool)
    ComponentSystemBase.GetSharedComponentTypeHandle<T>()
    ComponentSystemBase.GetDynamicSharedComponentTypeHandle(ComponentType)
    ComponentSystemBase.GetEntityTypeHandle()
    ComponentSystemBase.RequireForUpdate(EntityQuery)
    ComponentSystemBase.RequireAnyForUpdate(params EntityQuery[])
    ComponentSystemBase.RequireAnyForUpdate(NativeArray<EntityQuery>)
    ComponentSystemBase.RequireForUpdate<T>()
    ComponentSystemBase.RequireSingletonForUpdate<T>()
    ComponentSystemBase.HasSingleton<T>()
    ComponentSystemBase.GetSingleton<T>()
    ComponentSystemBase.GetSingletonRW<T>()
    ComponentSystemBase.GetSingletonBuffer<T>(bool)
    ComponentSystemBase.TryGetSingleton<T>(out T)
    ComponentSystemBase.TryGetSingletonBuffer<T>(out DynamicBuffer<T>)
    ComponentSystemBase.SetSingleton<T>(T)
    ComponentSystemBase.GetSingletonEntity<T>()
    ComponentSystemBase.TryGetSingletonEntity<T>(out Entity)
    ComponentSystemBase.GetEntityQuery(params ComponentType[])
    ComponentSystemBase.GetEntityQuery(NativeArray<ComponentType>)
    ComponentSystemBase.GetEntityQuery(params EntityQueryDesc[])
    ComponentSystemBase.GetEntityQuery(in EntityQueryBuilder)
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: Fwt.HexTerrains.Systems
    Assembly: fwt.hexterrains.dll
    Syntax
    public abstract class CalcCellMetricsSystem<TSurface> : SystemBase where TSurface : HexSurfaceLayer
    Type Parameters
    Name Description
    TSurface

    type of surface data this system calculates metrics for

    Methods

    CalcCellMetrics(TSurface)

    Call this method from inherited system to calculate cell metrics for the provided surface data. Override this method if you need to change the way cell metrics are calculated.

    Declaration
    public virtual void CalcCellMetrics(TSurface surfaceData)
    Parameters
    Type Name Description
    TSurface surfaceData

    ScheduleCalculateMetricsJob(HeightMapDataLayer, CellBiomesDataLayer, CellMetricsDataLayer, HexTerrainSettings, HexTerrainMetrics, JobHandle)

    Schedules a job that calculates CellMetrics for the provided surface data. Override this function if you want to schedule another job to do this.

    Declaration
    protected virtual JobHandle ScheduleCalculateMetricsJob(HeightMapDataLayer heightMap, CellBiomesDataLayer biomesMap, CellMetricsDataLayer cellMetrics, HexTerrainSettings settings, HexTerrainMetrics terrainMetrics, JobHandle dependency)
    Parameters
    Type Name Description
    HeightMapDataLayer heightMap

    HeightMap data layer

    CellBiomesDataLayer biomesMap

    BiomesMap data layer

    CellMetricsDataLayer cellMetrics

    CellMetrics data layer

    HexTerrainSettings settings

    settings of the terrain

    HexTerrainMetrics terrainMetrics

    metrics of the terrain

    JobHandle dependency

    JobHandle for scheduling a job that calculates metrics

    Returns
    Type Description
    JobHandle

    JobHandle of the scheduled job

    Extension Methods

    HashExtensions.GetHashCode_RefType<TValue>(TValue, int)
    HashExtensions.GetHashCode_RefType<TValue>(TValue, int)
    Extensions_UnityObject.SmartDestroy(object)
    Extensions_UnityObject.SmartDestroy(object)
    Extensions_UnityObject.SmartGetComponent<TComponent>(object)
    Extensions_UnityObject.SmartGetComponent<TComponent>(object)
    Extensions_UnityObject.SmartGetGameGameObject(object)
    Extensions_UnityObject.SmartGetGameGameObject(object)
    In this article
    Back to top Generated by DocFX