Topology

TOPOLOGY_getAdjacentFacelet

Summary

Get a facelet neighbor in the given direction.

Description

Facelet can have neighbors on the same cube face or neighbors by module. This function provide a neighbor of the given facelet in the given direction. Connection status indicates if there is a connection between modules on which given facelet and its neighbor are located.

Inputs

• facelet - a facelet which neighbor is requested
• direction - a direction in which neighbor is requested
• result - resulting facelet

Return value

Neighbor facelet in a given direction with its connection status. The module ID will be MODULES_MAX and the screen number will be SCREENS_MAX in case of an error (e.g. incorrect arguments or the topology malfunction).

Synopsis

1i32_t TOPOLOGY_getAdjacentFacelet(u32_t module, u32_t screen, u32_t direction, Cubios::TOPOLOGY_faceletInfo_t* result);
2 

TOPOLOGY_getFacelet

Summary

Get a facelet located at the given position of the face.

Inputs

• face - a face of a cube for which the facelet is requested
• position - a position of the module screen on the face
• mode - the face orientation mode
• result - resulting facelet

Return value

Facelet located at the given position.

Synopsis

1i32_t TOPOLOGY_getFacelet(u32_t face, u32_t position, Cubios::TOPOLOGY_orientation_mode_t mode, Cubios::TOPOLOGY_faceletInfo_t* result);
2 

TOPOLOGY_getPlace

Summary

Get a place of the facelet.

Inputs

• module - an index of a module
• screen - corresponding screen number
• result - resulting place

Return value

Place on cube surface where the given facelet located. Face will be TOPOLOGY_FACES_MAX and position will be TOPOLOGY_POSITIONS_MAX in case of an error (e.g. incorrect arguments or topology malfunction)

Synopsis

1i32_t TOPOLOGY_getPlace(u32_t module, u32_t screen, Cubios::TOPOLOGY_orientation_mode_t mode, Cubios::TOPOLOGY_place_t* result);
2 

TOPOLOGY_getOppositeFacelet

Summary

Get an opposite facelet located on a diagonal counterpart module.

Inputs

• module - an index of a module
• screen - corresponding screen number
• result - resulting facelet

Return value

Diagonal opposite counterpart facelet. Connection status indicates if there any connection to the module on which that facelet resides. The module ID will be MODULES_MAX and the screen number will be SCREENS_MAX in case of an error (e.g. incorrect arguments or topology malfunction).

Synopsis

1TOPOLOGY_getOppositeFacelet(u32_t module, u32_t screen, Cubios::TOPOLOGY_faceletInfo_t* result);
2 

TOPOLOGY_getAngle

Summary

Get an angle to align images on a face according to the orientation mode.

Description

Display coordinates system is persistent on a module screen. Different angles are needed to align images on all modules with screens on the same face. This function returns the angle for the screen specified by the facelet. The angle is relative to the position 0 on the same face where the facelet is located in the given orientation mode.

Inputs

• module - an index of a module
• screen - corresponding screen number
• mode - an orientation mode in which an angle is requested

Return value

Angle to align images on the same face according to the orientation mode, 0 in case of an error (e.g. incorrect arguments or the topology malfunction).

Synopsis

1i32_t TOPOLOGY_getAngle(u32_t module, u32_t screen, Cubios::TOPOLOGY_orientation_mode_t mode);
2 

TOPOLOGY_getFaceletOrientation

Summary

Get a face orientation on which the given facelet resides.

Inputs

• module - an index of a module
• screen - corresponding screen number

Return value

Face orientation on which the given facelet resides, ORIENTATION_MAX in case of an error (e.g. incorrect arguments or the topology malfunction).

Synopsis

1i32_t TOPOLOGY_getFaceletOrientation(u32_t module, u32_t screen);
2 

TOPOLOGY_getPlaceOrientation

Summary

• face - an index of a face
• position - position of the place

Inputs

place - a place for which the face orientation is requested

Return value

Face orientation on which the given place resides, ORIENTATION_MAX in case of an error (e.g. incorrect arguments or the topology malfunction).

Synopsis

1i32_t TOPOLOGY_getPlaceOrientation(u32_t face, u32_t position);
2 

TOPOLOGY_getFace

Summary

Get a face number which has the given orientation.

Inputs

• orientation - an orientation of the requested face

Return value

Face number which has the given orientation, TOPOLOGY_FACES_MAX in case of an error (e.g. incorrect arguments or the topology malfunction).

Synopsis

1i32_t TOPOLOGY_getFace(u32_t orientation);
2 

TOPOLOGY_isAssembled

Summary

Checks if all modules in a system are connected to each other.

Synopsis

1i32_t TOPOLOGY_isAssembled();
2 

TOPOLOGY_getTwist

Summary

Returns direction of the last twist

Inputs

• twist - a twist direction

Synopsis

1i32_t TOPOLOGY_getTwist(Cubios::TOPOLOGY_twistInfo_t* twist);
2