API reference
SortCriteriaBuilder Class
Builder class for creating sort criteria. All sort criteria are created using the "by" function.
This builder provides an API for defining multiple sort criteria that can be combined to create complex sorting logic. Example:
val entities = Query.where{ has(TestComponent.id) }
.sort {
with {
by(TestComponent.intVarData).desc()
}
}.eval()
Signature
class SortCriteriaBuilder
Constructors
SortCriteriaBuilder
()
:
SortCriteriaBuilder |
Signature
constructor() Returns |
Functions
build
()
:
List
|
Signature
fun build(): List<SortCriterion> Returns
List
|
by
(
intData
)
:
IntSortCriterion |
Create a sorting criterion for a given int attribute data.
Signature
fun by(intData: IntAttributeData): IntSortCriterion Parameters
intData:
IntAttributeData Returns
An IntSortCriterion instance that can be further configured with sort options.
Example:
with { by(TestComponent.intVarData) } // Sort by integer values in ascending order
|
by
(
longData
)
:
LongSortCriterion |
Create a sorting criterion for a given long attribute data.
Signature
fun by(longData: LongAttributeData): LongSortCriterion Parameters
longData:
LongAttributeData Returns
A LongSortCriterion instance that can be further configured with sort options.
Example:
with { by(TestComponent.longVarData).desc() } // Sort by long values in descending order
|
by
(
floatData
)
:
FloatSortCriterion |
Create a sorting criterion for a given float attribute data.
Signature
fun by(floatData: FloatAttributeData): FloatSortCriterion Parameters
floatData:
FloatAttributeData Returns
A FloatSortCriterion instance that can be further configured with sort options.
Example:
with { by(TestComponent.floatVarData) } // Sort by float values in ascending order
|
by
(
stringData
)
:
StringSortCriterion |
Create a sorting criterion for a given string attribute data.
Signature
fun by(stringData: StringAttributeData): StringSortCriterion Parameters
stringData:
StringAttributeData Returns
A StringSortCriterion instance that can be further configured with sort options, including case sensitivity options.
Example:
with { by(TestComponent.stringVarData).descCaseInsensitive() } // Sort strings in
descending order, ignoring case
|
by
(
vec2Data
)
:
Vector2SortCriterion |
Create a sorting criterion for a given vector2 attribute data.
Signature
fun by(vec2Data: Vector2AttributeData): Vector2SortCriterion Parameters
vec2Data:
Vector2AttributeData Returns
A Vector2SortCriterion instance that can be further configured to sort by specific components (X or Y) and sort direction.
Example:
with { by(TestComponent.vector2VarData).byX() } // Sort by X component in ascending order
with { by(TestComponent.vector2VarData).byY().desc() } // Sort by Y component in descending order
|
by
(
vec3Data
)
:
Vector3SortCriterion |
Create a sorting criterion for a given vector3 attribute data.
Signature
fun by(vec3Data: Vector3AttributeData): Vector3SortCriterion Parameters
vec3Data:
Vector3AttributeData Returns
A Vector3SortCriterion instance that can be further configured to sort by specific components (X, Y, or Z) and sort direction.
Example:
with { by(TestComponent.vector3VarData).byX() } // Sort by X component in ascending order
with { by(TestComponent.vector3VarData).byY().desc() } // Sort by Y component in descending order
with { by(TestComponent.vector3VarData).byZ() } // Sort by Z component in ascending order
|
by
(
vec4Data
)
:
Vector4SortCriterion |
Create a sorting criterion for a given vector4 attribute data.
Signature
fun by(vec4Data: Vector4AttributeData): Vector4SortCriterion Parameters
vec4Data:
Vector4AttributeData Returns
A Vector4SortCriterion instance that can be further configured to sort by specific components (X, Y, Z, or W) and sort direction.
Example:
with { by(TestComponent.vector4VarData).byX().desc() } // Sort by X component in descending order
with { by(TestComponent.vector4VarData).byY() } // Sort by Y component in ascending order
with { by(TestComponent.vector4VarData).byZ().desc() } // Sort by Z component in descending order
with { by(TestComponent.vector4VarData).byW() } // Sort by W component in ascending order
|
by
(
poseData
)
:
PoseSortCriterion |
Create a sorting criterion for a given pose attribute data.
Signature
fun by(poseData: PoseAttributeData): PoseSortCriterion Parameters
poseData:
PoseAttributeData Returns
A PoseSortCriterion instance that can be further configured to sort by specific position components (X, Y, Z) or orientation components (W, X, Y, Z) and sort direction.
Example:
with { by(TestComponent.poseVarData).byPositionX().desc() } // Sort by position X in descending order
with { by(TestComponent.poseVarData).byPositionY() } // Sort by position Y in ascending order
with { by(TestComponent.poseVarData).byOrientationW().desc() } // Sort by orientation W in descending order
|
by
(
timeData
)
:
TimeSortCriterion |
Create a sorting criterion for a given time attribute data.
Signature
fun by(timeData: TimeAttributeData): TimeSortCriterion Parameters
timeData:
TimeAttributeData Returns
A TimeSortCriterion instance that can be further configured with sort options.
Example:
with { by(TestComponent.timeVarData).desc() } // Sort by time values in descending order
|
Did you find this page helpful?
Virtual reality / Meta Horizon
Support and legal
Virtual reality / Meta Horizon
Support and legal
Virtual reality / Meta Horizon
Support and legal
English (US)
© 2026 Meta