NDEVR
API Documentation
DesignObjectSorterabstract

Allows for sorting models when supported. More...

Inheritance diagram for DesignObjectSorter:
[legend]
Collaboration diagram for DesignObjectSorter:
[legend]

Public Member Functions

virtual bool canSort (const DesignObject &a, const DesignObject &b) const =0
 Returns true if it is possible for this sorter to detemine the order of two objects.
virtual UUID id () const =0
 A unique identifier for this sorting service.
virtual bool isAGreaterThanB (const DesignObject &a, const DesignObject &b) const =0
 Returns true if a is evaluated to be less than b.

Detailed Description

Allows for sorting models when supported.


This can be used to augment the order in which objects appear in the SceneTree or in DesignObjectTables.

Definition at line 14 of file DesignObjectSorter.h.

Member Function Documentation

◆ canSort()

virtual bool DesignObjectSorter::canSort ( const DesignObject & a,
const DesignObject & b ) const
pure virtual

Returns true if it is possible for this sorter to detemine the order of two objects.

Parameters
aThe first DesignObject to sort
bThe second DesignObject to sort

◆ id()

virtual UUID DesignObjectSorter::id ( ) const
pure virtual

A unique identifier for this sorting service.

Returns
A unique identifier for this sorting service

◆ isAGreaterThanB()

virtual bool DesignObjectSorter::isAGreaterThanB ( const DesignObject & a,
const DesignObject & b ) const
pure virtual

Returns true if a is evaluated to be less than b.

Parameters
aThe first DesignObject to sort
bThe second DesignObject to sort
Returns
true if a is greater than b

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