• Installation Guide
  • Amoebot Model
  • User Guide
  • Model Reference
  • Dev Guide
  • API Documentation
Search Results for

    Show / Hide Table of Contents
    • AS2
      • AlgorithmGenerator
      • AlgorithmGeneratorEditor
      • AlgorithmManager
      • AlgorithmManager.AlgorithmInfo
      • AmoebotFunctions
      • AmoebotSimulator
      • CameraUtils
      • CellRect
      • CellRect.CellRect_Iterator
      • ColorData
      • Config
      • ConfigData
      • ConfigData.AdditionalConfiguration
      • ConfigData.SettingsMenu
      • ConfigurationEditor
      • ConfigurationEditorBehavior
      • Constants
      • Direction
      • DirectionHelpers
      • EventDatabase
      • FileBrowser
      • FileBrowser.FileTypeHandler
      • FilePaths
      • InitModeSaveData
      • InitParticleSaveData
      • InitRandomWithHoles
      • Initialization
      • Initialization.Chirality
      • Initialization.Compass
      • InitializationMethod
      • InitializationMethod.DistanceSortedVectorList
      • InitializationMethodManager
      • InitializationMethodManager.AlgorithmInfo
      • InitializationStateSaveData
      • Log
      • MaterialDatabase
      • MessageSaveData
      • MinMax
      • MouseController
      • PSPlacementMode
      • ParticleAttributeEnumSaveData
      • ParticleAttributePCSaveData
      • ParticleAttributeSaveDataBase
      • ParticleAttributeSaveData<T>
      • ParticleObjectSaveData
      • ParticleStateSaveData
      • PinConfigurationHistorySaveData
      • PinConfigurationSaveData
      • RandomNumberGenerator
      • SaveStateUtility
      • SimulationStateSaveData
      • StatusInfoAttribute
      • TypeConverter
      • TypeConverter.ConversionResult
      • UIDatabase
      • ValueHistorySaveData<T>
    • AS2.Algos.BeepFailureTest
      • BeepFailureTestParticle
    • AS2.Algos.BinOpTest
      • BinOpTestInitializer
      • BinOpTestParticle
      • BinOpTestParticle.Mode
    • AS2.Algos.BoundaryTest
      • BoundaryTestParticle
      • Phase
      • SCMode
    • AS2.Algos.BoundaryTestSub
      • BoundaryTestSubParticle
    • AS2.Algos.ChiralityCompass
      • ChiralityAndCompassInitializer
      • ChiralityAndCompassParticle
      • CoinTossResult
      • DirectionMessage
    • AS2.Algos.CollisionTestAlgo
      • CollisionTestAlgoInitializer
      • CollisionTestAlgoParticle
    • AS2.Algos.CollisionTestAlgo2
      • CollisionTestAlgo2Initializer
      • CollisionTestAlgo2Particle
      • Role
    • AS2.Algos.ExpandedCircuitTest
      • ExpandedCircuitTestInitializer
      • ExpandedCircuitTestParticle
    • AS2.Algos.JMTest
      • JMTestInitializer
      • JMTestParticle
    • AS2.Algos.LeaderElection
      • LeaderElectionInitializer
      • LeaderElectionParticle
    • AS2.Algos.LineFormation
      • LineFormationInitializer
      • LineFormationParticleSync
      • LineFormationParticleSync.LFState
      • MyMessage
      • MyMessage.Direction
    • AS2.Algos.ObjectTest
      • ObjectTestInitializer
      • ObjectTestParticle
    • AS2.Algos.PASCTestAlgo
      • PASCTestAlgoInitializer
      • PASCTestAlgoParticle
    • AS2.Algos.SingleSourceSP
      • SingleSourceSPInitializer
      • SingleSourceSPParticle
      • SingleSourceSPParticle.Phase
    • AS2.Algos.SmartMaterial
      • SmartMaterialInitializer
      • SmartMaterialParticle
    • AS2.Algos.SubroutineTest
      • SubroutineTestInitializer
      • SubroutineTestParticle
    • AS2.Algos.SubroutineTest2
      • SubroutineTest2Initializer
      • SubroutineTest2Particle
    • AS2.Sim
      • ActionType
      • AlgorithmException
      • AmoebotSimException
      • BondMovementInfo
      • BondMovementInfoList
      • Circuit
      • CollisionChecker
      • CollisionChecker.DebugLine
      • EdgeMovement
      • IParticleAttribute
      • IParticleObject
      • IReplayHistory
      • InitializationParticle
      • InvalidActionException
      • JointMovementInfo
      • Message
      • Neighbor<T>
      • OpenInitParticle
      • Particle
      • ParticleAction
      • ParticleAlgorithm
      • ParticleAttributeBase
      • ParticleAttributeFactory
      • ParticleAttributeWithHistory<T>
      • ParticleAttribute_Bool
      • ParticleAttribute_Direction
      • ParticleAttribute_Enum<T>
      • ParticleAttribute_Float
      • ParticleAttribute_Int
      • ParticleAttribute_PinConfiguration
      • ParticleAttribute_String
      • ParticleAttribute<T>
      • ParticleException
      • ParticleFactory
      • ParticleObject
      • ParticleSystem
      • ParticleSystem_Utils
      • PartitionSet
      • Pin
      • PinConfiguration
      • SimulationException
      • SimulatorException
      • SimulatorStateException
      • SysPartitionSet
      • SysPin
      • SysPinConfiguration
      • ValueHistoryBondInfo
      • ValueHistoryJointMovement
      • ValueHistoryMessage
      • ValueHistoryPinConfiguration
      • ValueHistory<T>
    • AS2.Subroutines
      • Subroutine
    • AS2.Subroutines.BinStateHelpers
      • BinAttributeBitField
      • BinAttributeBool
      • BinAttributeDirection
      • BinAttributeEnum<T>
      • BinAttributeInt
      • BinAttribute<T>
    • AS2.Subroutines.BinaryOps
      • BinOpUtils
      • SubAddition
      • SubBinOps
      • SubBinOps.Mode
      • SubComparison
      • SubComparison.ComparisonResult
      • SubDivision
      • SubMSBDetection
      • SubMultiplication
      • SubSubtraction
    • AS2.Subroutines.BoundaryTest
      • SubBoundaryTest
    • AS2.Subroutines.ETT
      • Comparison
      • SubETT
    • AS2.Subroutines.LeaderElection
      • SubLeaderElection
    • AS2.Subroutines.LeaderElectionFast
      • SubLeaderElectionFast
    • AS2.Subroutines.LeaderElectionSync
      • SubLeaderElectionSync
    • AS2.Subroutines.PASC
      • SubPASC
      • SubPASC2
      • SubPASC2.NbrType
    • AS2.UI
      • ButtonHoldTrigger
      • ClickAction
      • ClickAction.ClickButton
      • ClickAction.ClickType
      • InitializationUIHandler
      • InputAction
      • InputAction.InputType
      • InputController
      • InputHandler
      • InputHandler.MouseState
      • InputManager
      • LineDrawer
      • LogUIHandler
      • LogUIHandler.EntryType
      • ObjectUIHandler
      • ParticleUIExtensionSmoothLerp
      • ParticleUIHandler
      • SettingsUIHandler
      • SizeFitter
      • Tooltip
      • TooltipHandler
      • UIHandler
      • UIHandler.UITool
      • UISetting
      • UISetting_Color
      • UISetting_Color.InputType
      • UISetting_Dropdown
      • UISetting_Header
      • UISetting_MinMax
      • UISetting_MinMax.InputType
      • UISetting_Slider
      • UISetting_Spacing
      • UISetting_Text
      • UISetting_Text.InputType
      • UISetting_Toggle
      • UISetting_ValueSlider
      • WorldSpaceBackgroundUIHandler
      • WorldSpaceUIHandler
      • WorldSpaceUIHandler.ParticleTextUIData
      • WorldSpaceUIHandler.TextType
    • AS2.Visuals
      • CircleDistributionCircleArea
      • CircleDistributionCircleLine
      • IGenerateDynamicMesh
      • IObjectInfo
      • IParticleGraphicsAdapter
      • IParticleState
      • InstancedDrawer
      • MaterialPropertyBlockData
      • MaterialPropertyBlockData_Circuits
      • MaterialPropertyBlockData_Objects
      • MaterialPropertyBlockData_Particles
      • MeshCreator_CircularView
      • MeshCreator_HexagonalView
      • ObjectGraphicsAdapter
      • ObjectGraphicsAdapter.VertexInfo
      • PSetDragHandler
      • ParticleBondGraphicState
      • ParticleGraphicsAdapterImpl
      • ParticleGraphicsAdapterImpl.ParticleMovement
      • ParticleGraphicsAdapterImpl.PositionSnap
      • ParticleJointMovementState
      • ParticleMovementState
      • ParticlePinGraphicState
      • ParticlePinGraphicState.CodeOverrideType_Node
      • ParticlePinGraphicState.NeighborPinConnection
      • ParticlePinGraphicState.PSetData
      • ParticlePinGraphicState.PSetData.GraphicalData
      • ParticlePinGraphicState.PSetData.GraphicalData.CodeOverrideType_PSet
      • ParticlePinGraphicState.PinDef
      • PartitionSetViewType
      • Polar2DCoordinate
      • PriorityQueue<T>
      • RenderBatchIndex
      • RenderSystem
      • RendererBackground
      • RendererCircuitPins_RenderBatch
      • RendererCircuitPins_RenderBatch.PropertyBlockData
      • RendererCircuitsAndBonds
      • RendererCircuits_Instance
      • RendererCircuits_Instance.GDRef
      • RendererCircuits_Instance.ParticleCircuitData
      • RendererCircuits_Instance.ParticleCircuitData.PSetInnerPinRef
      • RendererCircuits_Instance.ParticleCircuitData.PSetInnerPinRef.PinType
      • RendererCircuits_RenderBatch
      • RendererCircuits_RenderBatch.PropertyBlockData
      • RendererCircuits_RenderBatch.PropertyBlockData.ActiveState
      • RendererCircuits_RenderBatch.PropertyBlockData.LineType
      • RendererObjects
      • RendererParticles
      • RendererParticles_RenderBatch
      • RendererParticles_RenderBatch.PropertyBlockData
      • RendererUI
      • TextureCreator
      • ViewType
    • AS2.Visuals.Library
      • DegreeConstants
      • InterpolationConstants
      • MatrixConstants
      • MeshConstants
      • VectorConstants
      • BasicSample
      • CanvasSampleSaveFileImage
      • CanvasSampleSaveFileText
      • HexagonalExpansionPrototype

    Class LogUIHandler

    Controls the log panel.

    Inheritance
    object
    LogUIHandler
    Namespace: AS2.UI
    Assembly: .dll
    Syntax
    public class LogUIHandler : MonoBehaviour

    Fields

    color_debug

    Declaration
    public Color color_debug
    Field Value
    Type Description
    Color

    color_error

    Declaration
    public Color color_error
    Field Value
    Type Description
    Color

    color_log

    Declaration
    public Color color_log
    Field Value
    Type Description
    Color

    color_warning

    Declaration
    public Color color_warning
    Field Value
    Type Description
    Color

    go_elementParent

    Declaration
    public GameObject go_elementParent
    Field Value
    Type Description
    GameObject

    go_expand

    Declaration
    public GameObject go_expand
    Field Value
    Type Description
    GameObject

    go_log

    Declaration
    public GameObject go_log
    Field Value
    Type Description
    GameObject

    instance

    Declaration
    public static LogUIHandler instance
    Field Value
    Type Description
    LogUIHandler

    keepVisible

    Declaration
    private bool keepVisible
    Field Value
    Type Description
    bool

    logElementList

    Declaration
    public List<GameObject> logElementList
    Field Value
    Type Description
    List<GameObject>

    logEntryID

    Declaration
    private int logEntryID
    Field Value
    Type Description
    int

    maxLogEntries

    Declaration
    private int maxLogEntries
    Field Value
    Type Description
    int

    scrollBar

    Declaration
    public Scrollbar scrollBar
    Field Value
    Type Description
    Scrollbar

    scrollRect

    Declaration
    public ScrollRect scrollRect
    Field Value
    Type Description
    ScrollRect

    scrollToBottomInAmountOfFrames

    Declaration
    private int scrollToBottomInAmountOfFrames
    Field Value
    Type Description
    int

    timeVisible

    Declaration
    private float timeVisible
    Field Value
    Type Description
    float

    timeVisibleInitial

    Declaration
    private float timeVisibleInitial
    Field Value
    Type Description
    float

    timestampLastInteraction

    Declaration
    private float timestampLastInteraction
    Field Value
    Type Description
    float

    Methods

    AddLogEntry(string, EntryType)

    Adds a log entry to the log.

    Declaration
    public void AddLogEntry(string text, LogUIHandler.EntryType type)
    Parameters
    Type Name Description
    string text

    The text to log.

    LogUIHandler.EntryType type

    The type of the log entry.

    AddLogEntry(string, EntryType, bool, bool)

    Adds a log entry to the log.

    Declaration
    protected void AddLogEntry(string text, LogUIHandler.EntryType type, bool showNumberOfEntry, bool useOldPrefab = false)
    Parameters
    Type Name Description
    string text

    The text to log.

    LogUIHandler.EntryType type

    The type of the log entry.

    bool showNumberOfEntry

    True if the number of the entry should be shown.

    bool useOldPrefab

    True if the old prefab which does not support multiline should be used. Recommendation: Keep this at false.

    AddWelcomeMessage()

    Adds the log entries making up the welcome message so that the log is not empty.

    Declaration
    private void AddWelcomeMessage()

    ButtonPressed_ClearLog()

    The user pressed the clear log button. Delete all log entries.

    Declaration
    public void ButtonPressed_ClearLog()

    ButtonPressed_CollapseLog()

    The user pressed the collapse log button. Hide the log panel.

    Declaration
    public void ButtonPressed_CollapseLog()

    ButtonPressed_ExpandLog()

    The user pressed the expand log button. Show the log panel.

    Declaration
    public void ButtonPressed_ExpandLog()

    GetLogElementTMPHeader(GameObject)

    Returns the TMP UGUI for the header.

    Declaration
    private TextMeshProUGUI GetLogElementTMPHeader(GameObject logElement)
    Parameters
    Type Name Description
    GameObject logElement
    Returns
    Type Description
    TextMeshProUGUI

    GetLogElementTMPText(GameObject)

    Returns the TMP UGUI for the text.

    Declaration
    private TextMeshProUGUI GetLogElementTMPText(GameObject logElement)
    Parameters
    Type Name Description
    GameObject logElement
    Returns
    Type Description
    TextMeshProUGUI

    GetLogElementTextMeshProUGUI(GameObject, int)

    Returns the first/second/third/etc... found TMP UGUI in the child elements of the log element. Index starting at 1.

    Declaration
    private TextMeshProUGUI GetLogElementTextMeshProUGUI(GameObject logElement, int firstSecondEtc)
    Parameters
    Type Name Description
    GameObject logElement
    int firstSecondEtc
    Returns
    Type Description
    TextMeshProUGUI

    Hide()

    Hides the log.

    Declaration
    public void Hide()

    InitLog()

    Initializes the log and writes some welcome message.

    Declaration
    private void InitLog()

    ScrollToBottom()

    Scrolls to the bottom of the log. We call this method after some very small number of frames because Unity needs to update some internal UI stuff before the sizes of the UI elements are in the system.

    Declaration
    public void ScrollToBottom()

    Show(bool, bool)

    Shows the log.

    Declaration
    public void Show(bool scrollDown, bool keepVisible)
    Parameters
    Type Name Description
    bool scrollDown

    True if the log should scroll down.

    bool keepVisible

    True if the log should be kept visible, false if it should disappear automatically after some time.

    Start()

    Declaration
    public void Start()

    Update()

    Update loop for the log UI, called each frame.

    Declaration
    public void Update()
    In this article
    Back to top AmoebotSim 2.0 Documentation v1.11
    Copyright © 2025 AmoebotSim 2.0 Authors
    Generated by DocFX