Lemmings
Remappable Gestures For Unity
Loading...
Searching...
No Matches
Lemmings Namespace Reference

Data Structures

class  GazeEvent
 UnityEvent triggered when this proxy's forward gaze detects a target GameObject. Includes the detected object and a confidence value (0-1). More...
interface  ILemming
 Interface for any reference to a tracked Lemming. More...
interface  ILemmingConverter
interface  ILemmingRelationship
 This is the interface for the relationship TODO: Determine if this is neccesary TODO: Right now it is not really utilized but might have value in building virtual relationships. More...
class  Lemming
 Component representing a tracked Lemming attached to a GameObject. More...
struct  LemmingBooler
class  LemmingCurveLibrary
class  LemmingDatum
 Represents a flexible container for storing a single value of varying data types. Supports types such as float, int, bool, Vector3, Quaternion, and string. More...
struct  LemmingFloater
 Represents a normalized floating-point value and provides tools to remap it across data types. More...
class  LemmingHerdSnapshot
 A fixed, read-only snapshot of a Lemming Herd configuration. Stores Lemming names, confidence values, and their associated GameObjects for runtime reference. Also generates a unique enum per snapshot for consistent name referencing. More...
struct  LemmingInter
 Represents an integer value with normalized remapping, directional interpolation, and support for flexible out-of-range behavior via Lemmings.LemmingInter.RangeBindingMode. More...
class  LemmingInterfaces
 Provides descriptions and optional editor UI for Lemming metric enum values. Helps clarify affordances and behaviors for user-facing tools. More...
class  LemmingProxyVisualizer
 Runtime-capable visual debug tool for proxies. Shows position, radius, axis direction, and links to member objects. Color-codes status, supports demo visuals in builds. More...
struct  LemmingReference
 A single named Lemming entry in the herd. More...
struct  LemmingRelation
 Represents a context for computing a spatial relationship metric across a given list of lemming GameObjects and family structure. Supports Single, Couple, Throuple, and Group types with metric-specific logic. More...
class  LemmingRelationSetting
 This is a class with numerous optional variables. This can be used to pass along settings for specific methods when appropriate. This is meant to be extensible for holding any setting options. More...
class  LemmingRelationship
 Defines a relationship among one or more Lemmings. Can be used to calculate positions, rotations, and derived values. More...
struct  LemmingRelationshipInfo
 This is a struct that holds the data from a relationship. Intended to streamline visualization and manipulation from external menus. More...
class  LemmingRelationshipInfoExtensions
 Extension methods for LemmingRelationshipInfo, enabling concise, fluent preview calls in UI or other code. More...
class  LemmingRelationshipProxy
 A MonoBehaviour that represents the spatial location and rotation of a LemmingRelationship. It provides support for spatial interaction detection such as gaze and triggers, and exposes that data via structured fields and UnityEvents. More...
struct  LemmingRotater
 A struct for managing and interpreting Quaternion rotations, including angular comparison, interpolation, remapping, and directional checks. More...
class  LemmingSecondaryMetric
 Allows previewing a secondary or alternate metric from an existing LemmingRelationship. Evaluates on-demand using public method call, avoiding continuous updates. More...
class  LemmingSettingDescriptions
class  LemmingShepherd
 Singleton container responsible for managing active Lemmings and their associated relationships. Provides central tracking, registration, and runtime access to all active Lemming objects and their connections to LemmingRelationships, supporting UI, analysis, and dynamic manipulation across scenes. More...
class  LemmingUtilities
class  LemmingUtils
 Utility class providing structural and scene-based helpers for working with Lemmings. Includes path resolution, transform tracking, and fallback object retrieval. More...
struct  LemmingVectorizer
 A struct for managing and interpreting a Vector3 value, including normalization, projection, direction checks, and remapping. More...
class  MetricSettingRegistry
 Provides preconfigured MetricSettingInfo entries for each supported setting. Used by editor UI to populate advanced configuration panels. More...
struct  Output
 This is a simple struct that holds the value outputs from a metric calculation. More...
class  ReadOnlyAttribute
 Optional attribute to lock fields to read-only in the Inspector. More...
class  RelationshipPreview
 Provides methods to perform a non-persistent, live preview of a spatial relationship defined by LemmingRelationshipInfo. Useful for UI remapping scenarios where users adjust settings and need immediate feedback without altering the original ScriptableObject. More...
class  RelationshipPreviewUtility
 This is a utility wrapper for the RelationshipPreview class to make it easier to use. example = Vector3 previewPos = RelationshipPreviewUtility.PreviewPosition(relationship);. More...
class  TagSelectorAttribute
 Attribute that enables tag dropdown selection for string fields in the inspector. More...
class  TriggerEvent
 UnityEvent that is triggered when a GameObject enters or exits this proxy's trigger collider. More...

Enumerations

enum  LemmingValueType {
  Float , Int , Bool , Vector3 ,
  Quaternion , String
}
 Setting of Lemming Value type for developers that want to gatekeep outputs.
enum  FamilyType { Single , Couple , Throuple , Group }
 For selecting the type of grouping used for evaluation.
enum  SingleMetric { Position , Rotation , Movement , Trigger }
 Safe Methods for Single Evaluations.
enum  CoupleMetric {
  Position , Rotation , Distance , Movement ,
  Difference , Trigger
}
 Safe Methods for Couple Evaluations.
enum  ThroupleMetric {
  Position , Rotation , Distance , Angle ,
  Density , Movement , Trigger , RotationAroundAxis ,
  Size
}
 Safe Methods for Throuple Evaluations.
enum  GroupMetric {
  Position , Rotation , Density , Size ,
  Movement , Trigger , RotationAroundAxis
}
 Safe Methods for Group Evaluations.
enum  RelationshipStatus { None , Over , Under , InRange }
 Holds the Boolean Status as an enum.
enum  LemmingCurveType {
  Linear , EaseIn , EaseOut , EaseInOut ,
  SineIn , SineOut , SineInOut , QuadraticIn ,
  QuadraticOut , QuadraticInOut , CubicIn , CubicOut ,
  CubicInOut , ExponentialIn , ExponentialOut , ExponentialInOut ,
  Custom
}
 Options for evaluation curve that modify the normalized value.
enum  DistanceOptions {
  CombinedAsVector3 , LeaderToFollower , FollowerToThird , ThirdToLeader ,
  TotalValue
}
 This only applies to Throuples.
enum  SingleAxis { X , Y , Z }
enum  DistanceUnit { Meters , Centimeters , Inches , Feet }
enum  AxisSelection {
  Up , Forward , Right , ObjectToCenter ,
  Custom
}
enum  AxisSelectionThrouple { CenterThroughLeader , CenterThroughThird , CenterThroughFollower }
enum  DensityMethod { AverageFromCenter , TotalFromCenter }
enum  SizeMethod { UseHeightWidthDepth , RadiusFromCenter }