Class StripDefinition

Namespace

Stride.UI

Assembly

Stride.UI.dll

Represents the definition of a grid strip.

[DataContract("StripDefinition")]
[Display(null, null, Expand = ExpandRule.Never)]
public class StripDefinition

Inheritance

object

StripDefinition

Constructors

StripDefinition()

Creates a 1-Star sized strip definition.

public StripDefinition()

StripDefinition(StripType, float)

Creates a StripDefinition with the provided size and type.

public StripDefinition(StripType type, float sizeValue = 1)

Parameters

type StripType

The type of the strip to create

sizeValue float

The value of the strip to create

Properties

ActualSize

The actual size of the strip in virtual pixels.

public float ActualSize { get; }

Property Value

float

MaximumSize

The maximum size of the strip in virtual pixels.

[DataMember]
[DataMemberRange(0, 3)]
public float MaximumSize { get; set; }

Property Value

float

Remarks

The value is coerced in the range [MinimumSize, PositiveInfinity].

MinimumSize

The minimum size of the strip in virtual pixels.

[DataMember]
[DataMemberRange(0, 3)]
public float MinimumSize { get; set; }

Property Value

float

Remarks

The value is coerced in the range [0, MaxValue].

SizeValue

Gets or sets the size value of the strip. Note that the value is interpreted differently depending on the strip Type.

[DataMember]
[DataMemberRange(0, 3)]
public float SizeValue { get; set; }

Property Value

float

Remarks

The value is coerced in the range [0, MaxValue].

Type

Gets or sets the type of the strip.

[DataMember]
public StripType Type { get; set; }

Property Value

StripType

Methods

ClampSizeByMinimumMaximum(float)

Clamp the provided size by the definition's minimum and maximum values.

public float ClampSizeByMinimumMaximum(float desiredSize)

Parameters

desiredSize float

The size to clamp

Returns

float

The size clamped by the minimum and maximum values of the strip definition