API reference
API reference
Select your platform
No SDKs available
No versions available

SortCriteriaBuilder

SortCriteriaBuilder

class SortCriteriaBuilder
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()

Constructors

NameSummary
SortCriteriaBuilder
constructor()

Functions

NameSummary
build
fun build(): List<SortCriterion>
by
fun by(floatData: FloatAttributeData): FloatSortCriterion

Create a sorting criterion for a given float attribute data.



fun by(intData: IntAttributeData): IntSortCriterion

Create a sorting criterion for a given int attribute data.



fun by(longData: LongAttributeData): LongSortCriterion

Create a sorting criterion for a given long attribute data.



fun by(poseData: PoseAttributeData): PoseSortCriterion

Create a sorting criterion for a given pose attribute data.



fun by(stringData: StringAttributeData): StringSortCriterion

Create a sorting criterion for a given string attribute data.



fun by(timeData: TimeAttributeData): TimeSortCriterion

Create a sorting criterion for a given time attribute data.



fun by(vec2Data: Vector2AttributeData): Vector2SortCriterion

Create a sorting criterion for a given vector2 attribute data.



fun by(vec3Data: Vector3AttributeData): Vector3SortCriterion

Create a sorting criterion for a given vector3 attribute data.



fun by(vec4Data: Vector4AttributeData): Vector4SortCriterion

Create a sorting criterion for a given vector4 attribute data.
Did you find this page helpful?
Thumbs up icon
Thumbs down icon