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...

Public Member Functions
	LemmingRelation (FamilyType family, List< LemmingReference > references, Enum metric, LemmingRelationSetting settings)
	Constructs a new relation context. This preffered method uses the full LemmingReference data which is more robust.
	LemmingRelation (FamilyType family, List< GameObject > gameObjects, Enum metric, LemmingRelationSetting settings)
	This constructor is for quick and dirty implementation in isolated cases. Developers might want to establish a Lemming Relationship for utility with non Lemming Game Objects.
object	Evaluate (LemmingRelationSetting setting=null)
	Evaluates the selected metric for the current family type and member set. Routes to an internal handler method based on FamilyType. Has an optional 'setting' parameter for passing optional settings.
LemmingDatum	ToDatum ()
	Wraps the result of the evaluation into a LemmingDatum. Useful for integration into other systems.

Data Fields
FamilyType	Family
	Defines the structural type of the relationship (e.g., Single, Couple, etc).
Enum	Metric
	The metric enum specific to the FamilyType that describes the desired output.

Properties
List< GameObject >	Members `[get]`
	The GameObjects involved in the spatial relationship. Expected to be size-matched to the FamilyType. Pulls directly from References or is defined when the struct is initialized.
List< LemmingReference >	References `[get]`
	The Full Lemming Reference entry for getting reliable access. Uses 'Get' so that a LemmingRelation can be used with basic game objects.
LemmingRelationSetting	Settings `[get]`
	This contains settings for how to process various metrics.

Private Member Functions
object	EvaluateSingle (SingleMetric metric, LemmingRelationSetting setting=null)
	Computes a spatial metric using a single GameObject.
Vector3	SinglePosition (LemmingRelationSetting setting=null)
	Get the Position datum for a single Lemming Relationship.
float	SinglePositionFloat (LemmingRelationSetting setting=null)
	Get the Position datum for a single Lemming Relationship where the value is for a single axis.
Quaternion	SingleRotation (LemmingRelationSetting setting=null)
	Get the rotation datum for a single Lemming Relationship.
bool	SingleRotationBool (LemmingRelationSetting setting=null)
	Returns a boolean based on whether the object is gazing at a tagged object, defined in the relationship proxy.
Vector3	SingleMovement (LemmingRelationSetting setting=null)
	Get the movement vector of a single Lemming. Applies settings for relative reference, direction-only formatting.
float	SingleMovementFloat (LemmingRelationSetting setting=null)
	Get the float value of a single Lemming's movement. Supports magnitude, single axis, or relative-to-object comparison.
bool	SingleTrigger (LemmingRelationSetting setting=null)
	Evaluates whether the proxy for a Single Lemming relationship is currently triggered.
object	EvaluateCouple (CoupleMetric metric, LemmingRelationSetting setting=null)
	Computes a spatial metric for a pair of GameObjects.
Vector3	CouplePosition (LemmingRelationSetting setting=null)
	Get the average world position between two Lemmings.
float	CouplePositionFloat (LemmingRelationSetting setting=null)
	Get the position along a selected axis or magnitude between two Lemmings.
Quaternion	CoupleRotation (LemmingRelationSetting setting=null)
	Get the Rotation of a Lemming Couple with multiple axis options.
bool	CoupleRotationBool (LemmingRelationSetting setting=null)
	Optional boolean output when rotation acts as a condition (e.g. gaze).
float	CoupleDistance (LemmingRelationSetting setting=null)
	The distance between the two Lemmings.
Vector3	CoupleMovement (LemmingRelationSetting setting=null)
	Get the average velocity of a Lemming Couple. Applies optional settings: directionOnly, relativeToObject.
float	CoupleMovementFloat (LemmingRelationSetting setting=null)
	Get the float representation of a Couple's movement. Supports magnitude, axis extraction, and relative-to-each-other projection.
Vector3	CoupleDifference (LemmingRelationSetting setting=null)
	Computes the difference vector from the first to the second member of a Couple.
float	CoupleDifferenceFloat (LemmingRelationSetting setting=null)
	Computes a scalar representing the magnitude or axis value of the difference vector between Couple members.
bool	CoupleTrigger (LemmingRelationSetting setting=null)
	Evaluates whether the proxy for a Couple relationship is currently triggered.
object	EvaluateThrouple (ThroupleMetric metric, LemmingRelationSetting setting=null)
	Computes a spatial metric across three GameObjects.
Vector3	ThrouplePosition (LemmingRelationSetting setting=null)
	Get the average world position across all three Lemmings.
float	ThrouplePositionFloat (LemmingRelationSetting setting=null)
	Get the averaged position across all three Lemmings as a float, filtered by axis if set.
Quaternion	ThroupleRotation (LemmingRelationSetting setting=null)
	Get the Rotation of a Lemming Throuple with defined axis rules.
bool	ThroupleRotationBool (LemmingRelationSetting setting=null)
	Optional boolean output when throuple rotation is acting as a condition (e.g. gaze).
Vector3	ThroupleDistance (LemmingRelationSetting setting=null)
float	ThroupleDistanceFloat (LemmingRelationSetting setting=null)
	Get a float representation of Throuple distance based on selected distance option. Supports unit scaling via DistanceUnit.
Vector3	ThroupleAngle (LemmingRelationSetting setting=null)
	Computes the angles between the three members of the Throuple, giving the corner angles at each member.
float	ThroupleAngleFloat (LemmingRelationSetting setting=null)
	Computes a float value representing one of the angles in the Throuple, based on axis preference.
float	ThroupleDensity (LemmingRelationSetting setting=null)
	Compute the density of the Throuple based on average or total distance to center.
Vector3	ThroupleMovement (LemmingRelationSetting setting=null)
	Get the average velocity of a Lemming Throuple. Applies optional settings: directionOnly, relativeToObject.
float	ThroupleMovementFloat (LemmingRelationSetting setting=null)
	Get a float representation of Throuple movement. Supports single axis filtering, magnitude, and center-relative projection.
bool	ThroupleTrigger (LemmingRelationSetting setting=null)
	Evaluates whether the proxy for a Throuple relationship is currently triggered.
float	ThroupleRotationAroundAxis (LemmingRelationSetting setting=null)
	Computes the signed angle (in degrees) between the Throuple's defined forward vector and a configurable reference direction, measured around an axis derived from the member layout. Useful for detecting twist, turn, or leaning in stable directional setups.
Vector3	ThroupleSize (LemmingRelationSetting setting=null)
	Get the bounding box size or radius of the Throuple based on selected method.
float	ThroupleSizeFloat (LemmingRelationSetting setting=null)
	Get a scalar representing the size of the Throuple’s bounding box or max radius, filtered by a single axis.
object	EvaluateGroup (GroupMetric metric, LemmingRelationSetting setting=null)
	Computes a spatial metric across a group of four or more GameObjects.
Vector3	GroupPosition (LemmingRelationSetting setting=null)
	Computes the average world position of all valid members in the group.
float	GroupPositionFloat (LemmingRelationSetting setting=null)
	Computes a float representation of the group’s average position, optionally filtered by axis.
Quaternion	GroupRotation (LemmingRelationSetting setting=null)
	Get the Rotation for a Lemming Group based on average velocity direction.
bool	GroupRotationBool (LemmingRelationSetting setting=null)
	Optional boolean output when group rotation is acting as a condition (e.g. gaze).
float	GroupDensity (LemmingRelationSetting setting=null)
	Compute the density of the group using average or total distance to center.
Vector3	GroupSize (LemmingRelationSetting setting=null)
	Get the Group's bounding box size or radius based on method.
float	GroupSizeFloat (LemmingRelationSetting setting=null)
	Get the Group’s size as a float using bounding box or radius, filtered by axis.
Vector3	GroupMovement (LemmingRelationSetting setting=null)
	Get the average movement velocity for a Lemming group, with support for direction-only or relative motion.
float	GroupMovementFloat (LemmingRelationSetting setting=null)
	Optional float override when group movement is reduced to a single axis or magnitude. Supports relative object comparisons.
bool	GroupTrigger (LemmingRelationSetting setting=null)
	Evaluates whether the proxy for a Group relationship is currently triggered.
float	GroupRotationAroundAxis (LemmingRelationSetting setting=null)
	Computes the signed angle (in degrees) between the Group's average velocity direction and a reference vector, measured around a specified axis. This is helpful for detecting group drift, heading deviation, or coordinated rotation in motion.

Detailed Description

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.

Constructor & Destructor Documentation

◆ LemmingRelation() [1/2]

Lemmings.LemmingRelation.LemmingRelation	(	FamilyType	family,
		List< LemmingReference >	references,
		Enum	metric,
		LemmingRelationSetting	settings )

inline

Constructs a new relation context. This preffered method uses the full LemmingReference data which is more robust.

Parameters

family	The type of relationship (e.g. Couple, Group).
references	The Lemming References involved in the relationship.
metric	The metric enum that defines what value to compute.

◆ LemmingRelation() [2/2]

Lemmings.LemmingRelation.LemmingRelation	(	FamilyType	family,
		List< GameObject >	gameObjects,
		Enum	metric,
		LemmingRelationSetting	settings )

inline

This constructor is for quick and dirty implementation in isolated cases. Developers might want to establish a Lemming Relationship for utility with non Lemming Game Objects.

Parameters

family	The type of relationship (e.g. Couple, Group).
gameObjects	The GameObjects being mapped as a spatial relationship.
metric	The metric enum that defines what value to compute.

Member Function Documentation

◆ CoupleDifference()

Vector3 Lemmings.LemmingRelation.CoupleDifference ( LemmingRelationSetting setting = null )

inlineprivate

Computes the difference vector from the first to the second member of a Couple.

Parameters

setting Optional axis filter settings.

Returns: Vector3 direction from Member[0] to Member[1].

◆ CoupleDifferenceFloat()

float Lemmings.LemmingRelation.CoupleDifferenceFloat ( LemmingRelationSetting setting = null )

inlineprivate

Computes a scalar representing the magnitude or axis value of the difference vector between Couple members.

Parameters

setting Optional single axis filtering.

Returns: Float representing direction difference along selected axis or full magnitude.

◆ CoupleDistance()

float Lemmings.LemmingRelation.CoupleDistance ( LemmingRelationSetting setting = null )

inlineprivate

The distance between the two Lemmings.

Parameters

setting Can choose to select a relevant scale

Returns: The distance between the two Lemmings

◆ CoupleMovement()

Vector3 Lemmings.LemmingRelation.CoupleMovement ( LemmingRelationSetting setting = null )

inlineprivate

Get the average velocity of a Lemming Couple. Applies optional settings: directionOnly, relativeToObject.

Parameters

setting Optional settings for axis filtering or reference adjustment.

Returns: Vector3 representing couple's motion.

◆ CoupleMovementFloat()

float Lemmings.LemmingRelation.CoupleMovementFloat ( LemmingRelationSetting setting = null )

inlineprivate

Get the float representation of a Couple's movement. Supports magnitude, axis extraction, and relative-to-each-other projection.

Parameters

setting Optional settings for formatting or projection.

Returns: Float representing motion of couple.

◆ CouplePosition()

Vector3 Lemmings.LemmingRelation.CouplePosition ( LemmingRelationSetting setting = null )

inlineprivate

Get the average world position between two Lemmings.

Parameters

setting Optional settings (e.g. axis filtering)

Returns: The average Vector3 position

◆ CouplePositionFloat()

float Lemmings.LemmingRelation.CouplePositionFloat ( LemmingRelationSetting setting = null )

inlineprivate

Get the position along a selected axis or magnitude between two Lemmings.

Parameters

setting Optional settings (e.g. axis filtering)

Returns: A float representing either a selected axis or the magnitude of the average position

◆ CoupleRotation()

Quaternion Lemmings.LemmingRelation.CoupleRotation ( LemmingRelationSetting setting = null )

inlineprivate

Get the Rotation of a Lemming Couple with multiple axis options.

Parameters

setting Optional settings for customizing the rotation axis and behavior.

Returns: A Quaternion representing the orientation of the couple.

◆ CoupleRotationBool()

bool Lemmings.LemmingRelation.CoupleRotationBool ( LemmingRelationSetting setting = null )

inlineprivate

Optional boolean output when rotation acts as a condition (e.g. gaze).

Parameters

setting Setting must include a proxy reference and optionally a confidence threshold.

Returns: True if the proxy is currently gazing at a valid target with sufficient confidence.

◆ CoupleTrigger()

bool Lemmings.LemmingRelation.CoupleTrigger ( LemmingRelationSetting setting = null )

inlineprivate

Evaluates whether the proxy for a Couple relationship is currently triggered.

Parameters

setting Must include a proxy reference.

Returns: True if proxy is triggered, false otherwise.

◆ Evaluate()

object Lemmings.LemmingRelation.Evaluate ( LemmingRelationSetting setting = null )

inline

Evaluates the selected metric for the current family type and member set. Routes to an internal handler method based on FamilyType. Has an optional 'setting' parameter for passing optional settings.

Returns: The computed result for the selected metric, boxed as an object.

◆ EvaluateCouple()

object Lemmings.LemmingRelation.EvaluateCouple	(	CoupleMetric	metric,
		LemmingRelationSetting	setting = null )

inlineprivate

Computes a spatial metric for a pair of GameObjects.

Parameters

metric	The couple-specific metric to evaluate.
setting	This can later hold settings if required

Returns: The resulting value, either numeric, vector, or boolean.

◆ EvaluateGroup()

object Lemmings.LemmingRelation.EvaluateGroup	(	GroupMetric	metric,
		LemmingRelationSetting	setting = null )

inlineprivate

Computes a spatial metric across a group of four or more GameObjects.

Parameters

metric	The group metric to compute.
setting	Optional Settings for evaluation

Returns: The computed result, typically a float, Vector3, or Quaternion.

◆ EvaluateSingle()

object Lemmings.LemmingRelation.EvaluateSingle	(	SingleMetric	metric,
		LemmingRelationSetting	setting = null )

inlineprivate

Computes a spatial metric using a single GameObject.

Parameters

metric	The single-object metric to compute.
setting	This can later hold settings if required

Returns: The resulting value for the metric.

◆ EvaluateThrouple()

object Lemmings.LemmingRelation.EvaluateThrouple	(	ThroupleMetric	metric,
		LemmingRelationSetting	setting = null )

inlineprivate

Computes a spatial metric across three GameObjects.

Parameters

metric	The throuple-specific metric to evaluate.
setting	Optional settings for evaluation

Returns: The computed result specific to the chosen metric.

◆ GroupDensity()

float Lemmings.LemmingRelation.GroupDensity ( LemmingRelationSetting setting = null )

inlineprivate

Compute the density of the group using average or total distance to center.

Parameters

setting Optional settings including method and unit.

Returns: Float density value.

◆ GroupMovement()

Vector3 Lemmings.LemmingRelation.GroupMovement ( LemmingRelationSetting setting = null )

inlineprivate

Get the average movement velocity for a Lemming group, with support for direction-only or relative motion.

Parameters

setting Optional settings controlling normalization and relative calculation.

Returns: Vector3 representing group movement.

◆ GroupMovementFloat()

float Lemmings.LemmingRelation.GroupMovementFloat ( LemmingRelationSetting setting = null )

inlineprivate

Optional float override when group movement is reduced to a single axis or magnitude. Supports relative object comparisons.

Parameters

setting Optional settings: single axis, magnitudeOnly, and relative reference.

Returns: Float value of the group movement adjusted to requested setting.

◆ GroupPosition()

Vector3 Lemmings.LemmingRelation.GroupPosition ( LemmingRelationSetting setting = null )

inlineprivate

Computes the average world position of all valid members in the group.

Parameters

setting Optional settings (not currently used)

Returns: The average Vector3 position of all members

◆ GroupPositionFloat()

float Lemmings.LemmingRelation.GroupPositionFloat ( LemmingRelationSetting setting = null )

inlineprivate

Computes a float representation of the group’s average position, optionally filtered by axis.

Parameters

setting Optional settings for axis filtering

Returns: Float representing axis value or magnitude of average

◆ GroupRotation()

Quaternion Lemmings.LemmingRelation.GroupRotation ( LemmingRelationSetting setting = null )

inlineprivate

Get the Rotation for a Lemming Group based on average velocity direction.

Parameters

setting Optional setting with invert toggle.

Returns: A Quaternion facing the direction of group motion or identity if no movement is detected.

◆ GroupRotationAroundAxis()

float Lemmings.LemmingRelation.GroupRotationAroundAxis ( LemmingRelationSetting setting = null )

inlineprivate

Computes the signed angle (in degrees) between the Group's average velocity direction and a reference vector, measured around a specified axis. This is helpful for detecting group drift, heading deviation, or coordinated rotation in motion.

Parameters

setting Settings control the rotation axis, reference vector selection, and optional inversion.

Returns: Signed angle in degrees (float) based on group motion and selected axis context.

◆ GroupRotationBool()

bool Lemmings.LemmingRelation.GroupRotationBool ( LemmingRelationSetting setting = null )

inlineprivate

Optional boolean output when group rotation is acting as a condition (e.g. gaze).

Parameters

setting Setting must include a proxy reference and optionally a confidence threshold.

Returns: True if the proxy is currently gazing at a valid target with sufficient confidence.

◆ GroupSize()

Vector3 Lemmings.LemmingRelation.GroupSize ( LemmingRelationSetting setting = null )

inlineprivate

Get the Group's bounding box size or radius based on method.

Parameters

setting Optional settings.

Returns: Size as a Vector3.

◆ GroupSizeFloat()

float Lemmings.LemmingRelation.GroupSizeFloat ( LemmingRelationSetting setting = null )

inlineprivate

Get the Group’s size as a float using bounding box or radius, filtered by axis.

Parameters

setting Axis filtering and size method options.

Returns: Size as float (magnitude or single axis).

◆ GroupTrigger()

bool Lemmings.LemmingRelation.GroupTrigger ( LemmingRelationSetting setting = null )

inlineprivate

Evaluates whether the proxy for a Group relationship is currently triggered.

Parameters

setting Must include a proxy reference.

Returns: True if proxy is triggered, false otherwise.

◆ SingleMovement()

Vector3 Lemmings.LemmingRelation.SingleMovement ( LemmingRelationSetting setting = null )

inlineprivate

Get the movement vector of a single Lemming. Applies settings for relative reference, direction-only formatting.

Parameters

setting Optional configuration of relative reference or formatting.

Returns: Velocity vector of the single Lemming.

◆ SingleMovementFloat()

float Lemmings.LemmingRelation.SingleMovementFloat ( LemmingRelationSetting setting = null )

inlineprivate

Get the float value of a single Lemming's movement. Supports magnitude, single axis, or relative-to-object comparison.

Parameters

setting Optional configuration for formatting or comparison behavior.

Returns: Float value of velocity for a single Lemming.

◆ SinglePosition()

Vector3 Lemmings.LemmingRelation.SinglePosition ( LemmingRelationSetting setting = null )

inlineprivate

Get the Position datum for a single Lemming Relationship.

Parameters

setting This can later hold settings if required

Returns: The position of the Lemming source

◆ SinglePositionFloat()

float Lemmings.LemmingRelation.SinglePositionFloat ( LemmingRelationSetting setting = null )

inlineprivate

Get the Position datum for a single Lemming Relationship where the value is for a single axis.

Parameters

setting This can later hold settings if required

Returns: The value of the Lemming source in a given axis

◆ SingleRotation()

Quaternion Lemmings.LemmingRelation.SingleRotation ( LemmingRelationSetting setting = null )

inlineprivate

Get the rotation datum for a single Lemming Relationship.

Parameters

setting This can later hold settings if required

Returns: The rotation of the Lemming source

◆ SingleRotationBool()

bool Lemmings.LemmingRelation.SingleRotationBool ( LemmingRelationSetting setting = null )

inlineprivate

Returns a boolean based on whether the object is gazing at a tagged object, defined in the relationship proxy.

Parameters

setting This hold the proxy and the threshold for establishing gaze

Returns: True if an object is being seen and false if not

◆ SingleTrigger()

bool Lemmings.LemmingRelation.SingleTrigger ( LemmingRelationSetting setting = null )

inlineprivate

Evaluates whether the proxy for a Single Lemming relationship is currently triggered.

Parameters

setting Must include a proxy reference.

Returns: True if proxy is triggered, false otherwise.

◆ ThroupleAngle()

Vector3 Lemmings.LemmingRelation.ThroupleAngle ( LemmingRelationSetting setting = null )

inlineprivate

Computes the angles between the three members of the Throuple, giving the corner angles at each member.

Parameters

setting Optional axis filtering or distance unit scaling.

Returns: A Vector3 where X = angle at the Leader position, Y = angle at the Follower position, Z = angle at the Third position.

◆ ThroupleAngleFloat()

float Lemmings.LemmingRelation.ThroupleAngleFloat ( LemmingRelationSetting setting = null )

inlineprivate

Computes a float value representing one of the angles in the Throuple, based on axis preference.

Parameters

setting Optional single axis selection. Defaults to average if none.

Returns: Float angle in degrees.

◆ ThroupleDensity()

float Lemmings.LemmingRelation.ThroupleDensity ( LemmingRelationSetting setting = null )

inlineprivate

Compute the density of the Throuple based on average or total distance to center.

Parameters

setting Optional distance method and unit conversion.

Returns: Density as a float.

◆ ThroupleDistanceFloat()

float Lemmings.LemmingRelation.ThroupleDistanceFloat ( LemmingRelationSetting setting = null )

inlineprivate

Get a float representation of Throuple distance based on selected distance option. Supports unit scaling via DistanceUnit.

Parameters

setting Optional setting to choose pair type and unit format.

Returns: Float distance scaled to unit and selected configuration.

◆ ThroupleMovement()

Vector3 Lemmings.LemmingRelation.ThroupleMovement ( LemmingRelationSetting setting = null )

inlineprivate

Get the average velocity of a Lemming Throuple. Applies optional settings: directionOnly, relativeToObject.

Parameters

setting Optional settings for formatting or reference adjustment.

Returns: Vector3 representing motion of throuple.

◆ ThroupleMovementFloat()

float Lemmings.LemmingRelation.ThroupleMovementFloat ( LemmingRelationSetting setting = null )

inlineprivate

Get a float representation of Throuple movement. Supports single axis filtering, magnitude, and center-relative projection.

Parameters

setting Optional settings for float formatting or group-relative behavior.

Returns: Float representing movement of the throuple.

◆ ThrouplePosition()

Vector3 Lemmings.LemmingRelation.ThrouplePosition ( LemmingRelationSetting setting = null )

inlineprivate

Get the average world position across all three Lemmings.

Parameters

setting Optional settings (not currently used)

Returns: The average Vector3 position

◆ ThrouplePositionFloat()

float Lemmings.LemmingRelation.ThrouplePositionFloat ( LemmingRelationSetting setting = null )

inlineprivate

Get the averaged position across all three Lemmings as a float, filtered by axis if set.

Parameters

setting Optional settings for axis filtering

Returns: A float value representing a single axis, or magnitude, of the average position

◆ ThroupleRotation()

Quaternion Lemmings.LemmingRelation.ThroupleRotation ( LemmingRelationSetting setting = null )

inlineprivate

Get the Rotation of a Lemming Throuple with defined axis rules.

Parameters

setting Settings for controlling axis direction and style.

Returns: A Quaternion describing the orientation based on throuple layout.

◆ ThroupleRotationAroundAxis()

float Lemmings.LemmingRelation.ThroupleRotationAroundAxis ( LemmingRelationSetting setting = null )

inlineprivate

Computes the signed angle (in degrees) between the Throuple's defined forward vector and a configurable reference direction, measured around an axis derived from the member layout. Useful for detecting twist, turn, or leaning in stable directional setups.

Parameters

setting Settings define how the primary and reference axes are selected and whether inversion is applied.

Returns: Signed angle in degrees between forward and reference (0 = aligned, ±180 = fully opposed).

◆ ThroupleRotationBool()

bool Lemmings.LemmingRelation.ThroupleRotationBool ( LemmingRelationSetting setting = null )

inlineprivate

Optional boolean output when throuple rotation is acting as a condition (e.g. gaze).

Parameters

setting Setting must include a proxy reference and optionally a confidence threshold.

Returns: True if the proxy is currently gazing at a valid target with sufficient confidence.

◆ ThroupleSize()

Vector3 Lemmings.LemmingRelation.ThroupleSize ( LemmingRelationSetting setting = null )

inlineprivate

Get the bounding box size or radius of the Throuple based on selected method.

Parameters

setting Optional settings: size method and axis filtering.

Returns: A Vector3 representing the bounding box size or max radius.

◆ ThroupleSizeFloat()

float Lemmings.LemmingRelation.ThroupleSizeFloat ( LemmingRelationSetting setting = null )

inlineprivate

Get a scalar representing the size of the Throuple’s bounding box or max radius, filtered by a single axis.

Parameters

setting Optional settings to determine method and axis.

Returns: A float representing the axis-aligned size or radius.

◆ ThroupleTrigger()

bool Lemmings.LemmingRelation.ThroupleTrigger ( LemmingRelationSetting setting = null )

inlineprivate

Evaluates whether the proxy for a Throuple relationship is currently triggered.

Parameters

setting Must include a proxy reference.

Returns: True if proxy is triggered, false otherwise.

◆ ToDatum()

LemmingDatum Lemmings.LemmingRelation.ToDatum ( )

inline

Wraps the result of the evaluation into a LemmingDatum. Useful for integration into other systems.

Returns: A LemmingDatum representing the evaluated value.

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

Assets/Lemmings/Scripts/Namespace/LemmingRelationshipStruct.cs

Public Member Functions

Data Fields

Properties

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ LemmingRelation() [1/2]

◆ LemmingRelation() [2/2]

Member Function Documentation

◆ CoupleDifference()

◆ CoupleDifferenceFloat()

◆ CoupleDistance()

◆ CoupleMovement()

◆ CoupleMovementFloat()

◆ CouplePosition()

◆ CouplePositionFloat()

◆ CoupleRotation()

◆ CoupleRotationBool()

◆ CoupleTrigger()

◆ Evaluate()

◆ EvaluateCouple()

◆ EvaluateGroup()

◆ EvaluateSingle()

◆ EvaluateThrouple()

◆ GroupDensity()

◆ GroupMovement()

◆ GroupMovementFloat()

◆ GroupPosition()

◆ GroupPositionFloat()

◆ GroupRotation()

◆ GroupRotationAroundAxis()

◆ GroupRotationBool()

◆ GroupSize()

◆ GroupSizeFloat()

◆ GroupTrigger()

◆ SingleMovement()

◆ SingleMovementFloat()

◆ SinglePosition()

◆ SinglePositionFloat()

◆ SingleRotation()

◆ SingleRotationBool()

◆ SingleTrigger()

◆ ThroupleAngle()

◆ ThroupleAngleFloat()

◆ ThroupleDensity()

◆ ThroupleDistanceFloat()

◆ ThroupleMovement()

◆ ThroupleMovementFloat()

◆ ThrouplePosition()

◆ ThrouplePositionFloat()

◆ ThroupleRotation()

◆ ThroupleRotationAroundAxis()

◆ ThroupleRotationBool()

◆ ThroupleSize()

◆ ThroupleSizeFloat()

◆ ThroupleTrigger()

◆ ToDatum()