StripDefinition Class
Namespace: Stride.UIAssembly: Stride.UI.dll
Represents the definition of a grid strip.
[DataContract("StripDefinition")]
[Display(null, null, Expand = ExpandRule.Never)]
public class StripDefinition
Name | Description | |
---|---|---|
Constructors | ||
StripDefinition() | Creates a 1-Star sized strip definition. |
|
StripDefinition(StripType, Single) | Creates a StripDefinition with the provided size and type. |
|
Properties | ||
ActualSize | The actual size of the strip in virtual pixels. |
|
MaximumSize | The maximum size of the strip in virtual pixels. |
|
MinimumSize | The minimum size of the strip in virtual pixels. |
|
SizeValue | Gets or sets the size value of the strip. Note that the value is interpreted differently depending on the strip Type. |
|
Type | Gets or sets the type of the strip. |
|
Methods | ||
ClampSizeByMinimumMaximum(Single) | Clamp the provided size by the definition's minimum and maximum values. |
Constructors
StripDefinition()
Creates a 1-Star sized strip definition.
public StripDefinition()
StripDefinition(StripType, Single)
Creates a StripDefinition with the provided size and type.
public StripDefinition(StripType type, float sizeValue = 1F)
Parameters
Type | Name | Description |
---|---|---|
StripType | type | The type of the strip to create |
System.Single | sizeValue | The value of the strip to create |
Properties
ActualSize
The actual size of the strip in virtual pixels.
public float ActualSize { get; }
Property Value
Type | Description |
---|---|
System.Single |
MaximumSize
The maximum size of the strip in virtual pixels.
[DataMember]
[DataMemberRange(0, 3)]
public float MaximumSize { get; set; }
Property Value
Type | Description |
---|---|
System.Single |
Remarks
The value is coerced in the range [MinimumSize, System.Single.PositiveInfinity].
MinimumSize
The minimum size of the strip in virtual pixels.
[DataMember]
[DataMemberRange(0, 3)]
public float MinimumSize { get; set; }
Property Value
Type | Description |
---|---|
System.Single |
Remarks
The value is coerced in the range [0, System.Single.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
Type | Description |
---|---|
System.Single |
Remarks
The value is coerced in the range [0, System.Single.MaxValue].
Type
Gets or sets the type of the strip.
[DataMember]
public StripType Type { get; set; }
Property Value
Type | Description |
---|---|
StripType |
Methods
ClampSizeByMinimumMaximum(Single)
Clamp the provided size by the definition's minimum and maximum values.
public float ClampSizeByMinimumMaximum(float desiredSize)
Parameters
Type | Name | Description |
---|---|---|
System.Single | desiredSize | The size to clamp |
Returns
Type | Description |
---|---|
System.Single | The size clamped by the minimum and maximum values of the strip definition |