ArtificialHorizon Properties

Control artificial horizon appearance and behavior

Artificial horizons are components that represent an artificial horizon. Properties control the appearance and behavior of an artificial horizon. Use dot notation to refer to a particular object and property:

f = uifigure;
artificialhorizon = uiaerohorizon(f);
artificialhorizon.Value = [100 20];

The artificial horizon represents aircraft attitude relative to horizon and displays roll and pitch in degrees:

• Values for roll cannot exceed +/– 90 degrees.

• Values for pitch cannot exceed +/– 30 degrees.

If the values exceed the maximum values, the gauge maximum and minimum values do not change.

Changes in roll value affect the gauge semicircles and the ticks located on the black arc turn accordingly. Changes in pitch value affect the scales and the distribution of the semicircles.

Artificial Horizon

Pitch — Pitch

0 (default) | finite, real, and scalar numeric

Pitch value, specified as any finite and scalar numeric. The pitch value determines the movement of the aircraft around the transverse axis, in degrees.

Example: 10

Dependencies

Specifying this value changes the second element of the Value vector. Conversely, changing the second element of the Value vector changes the Pitch value.

Data Types: double

Roll — Roll

0 (default) | finite, real, and scalar numeric

Roll value, specified as any finite and scalar numeric. The roll value determines the rotation of the aircraft around the longitudinal axis, in degrees.

Example: 10

Dependencies

Specifying this value changes the first element of the Value vector. Conversely, changing the first element of the Value vector changes the Roll value.

Data Types: double

Value — Roll and pitch

[0 0] (default) | two-element vector of finite, real, and scalar numerics

Roll and pitch values, specified as a vector ([Roll Pitch]).

• The roll value determines the rotation of the aircraft around the longitudinal axis.

• The pitch value determines the movement of the aircraft around the transverse axis.

Example: [100 -200]

Dependencies

• Specifying the Roll value changes the first element of the Value vector. Conversely, changing the first element of the Value vector changes the Roll value.

• Specifying the Pitch value changes the second element of the Value vector. Conversely, changing the second element of the Value vector changes the Pitch value.

Data Types: double

Interactivity

Visible — Visibility of artificial horizon

'on' (default) | on/off logical value

Visibility of the artificial horizon, specified as 'on' or 'off', or as numeric or logical 1 (true) or 0 (false). A value of 'on' is equivalent to true, and 'off' is equivalent to false. Thus, you can use the value of this property as a logical value. The value is stored as an on/off logical value of type matlab.lang.OnOffSwitchState. The Visible property determines whether the artificial horizon, is displayed on the screen. If the Visible property is set to 'off', then the entire artificial horizon is hidden, but you can still specify and access its properties.

ContextMenu — Context menu

empty GraphicsPlaceholder array (default) | ContextMenu object

Context menu, specified as a ContextMenu object created using the uicontextmenu function. Use this property to display a context menu when you right-click on a component.

Enable — Operational state of artificial horizon

'on' (default) | on/off logical value

Operational state of artificial horizon, specified as 'on' or 'off', or as numeric or logical 1 (true) or 0 (false). A value of 'on' is equivalent to true, and 'off' is equivalent to false. Thus, you can use the value of this property as a logical value. The value is stored as an on/off logical value of type matlab.lang.OnOffSwitchState.

• If you set this property to 'on', then the appearance of the artificial horizon indicates that the artificial horizon is operational.

• If you set this property to 'off', then the appearance of the artificial horizon appears dimmed, indicating that the artificial horizon is not operational.

Position

Position — Location and size of artificial horizon

[100 100 120 120] (default) | [left bottom width height]

Location and size of the artificial horizon relative to the parent container, specified as the vector, [left bottom width height]. This table describes each element in the vector.

Element	Description
left	Distance from the inner left edge of the parent container to the outer left edge of an imaginary box surrounding the artificial horizon
bottom	Distance from the inner bottom edge of the parent container to the outer bottom edge of an imaginary box surrounding the artificial horizon
width	Distance between the right and left outer edges of the artificial horizon
height	Distance between the top and bottom outer edges of the artificial horizon

All measurements are in pixel units.

The Position values are relative to the drawable area of the parent container. The drawable area is the area inside the borders of the container and does not include the area occupied by decorations such as a menu bar or title.

Example: [200 120 120 120]

InnerPosition — Inner location and size of artificial horizon

[100 100 120 120] (default) | [left bottom width height]

Inner location and size of the artificial horizon, specified as [left bottom width height]. Position values are relative to the parent container. All measurements are in pixel units. This property value is identical to the Position property.

OuterPosition — Outer location and size of artificial horizon

Read-only: [100 100 120 120]] (default) | [left bottom width height]

This property is read-only.

Outer location and size of the artificial horizon returned as [left bottom width height]. Position values are relative to the parent container. All measurements are in pixel units. This property value is identical to the Position property.

Layout — Layout options

empty LayoutOptions array (default) | GridLayoutOptions object

Layout options, specified as a GridLayoutOptions object. This property specifies options for components that are children of grid layout containers. If the component is not a child of a grid layout container (for example, it is a child of a figure or panel), then this property is empty and has no effect. However, if the component is a child of a grid layout container, you can place the component in the desired row and column of the grid by setting the Row and Column properties on the GridLayoutOptions object.

For example, this code places an artificial horizon in the third row and second column of its parent grid.

g = uigridlayout([4 3]);
gauge = uiaerohorizon(g);
gauge.Layout.Row = 3;
gauge.Layout.Column = 2;

To make the artificial horizon span multiple rows or columns, specify the Row or Column property as a two-element vector. For example, this artificial horizon spans columns 2 through 3:

gauge.Layout.Column = [2 3];

Callbacks

CreateFcn — Creation function

'' (default) | function handle | cell array | character vector

Object creation function, specified as one of these values:

• Function handle.

• Cell array in which the first element is a function handle. Subsequent elements in the cell array are the arguments to pass to the callback function.

• Character vector containing a valid MATLAB^® expression (not recommended). MATLAB evaluates this expression in the base workspace.

For more information about specifying a callback as a function handle, cell array, or character vector, see Callbacks in App Designer.

This property specifies a callback function to execute when MATLAB creates the object. MATLAB initializes all property values before executing the CreateFcn callback. If you do not specify the CreateFcn property, then MATLAB executes a default creation function.

Setting the CreateFcn property on an existing component has no effect.

If you specify this property as a function handle or cell array, you can access the object that is being created using the first argument of the callback function. Otherwise, use the gcbo function to access the object.

DeleteFcn — Deletion function

'' (default) | function handle | cell array | character vector

Object deletion function, specified as one of these values:

• Function handle.

• Cell array in which the first element is a function handle. Subsequent elements in the cell array are the arguments to pass to the callback function.

• Character vector containing a valid MATLAB expression (not recommended). MATLAB evaluates this expression in the base workspace.

For more information about specifying a callback as a function handle, cell array, or character vector, see Callbacks in App Designer.

This property specifies a callback function to execute when MATLAB deletes the object. MATLAB executes the DeleteFcn callback before destroying the properties of the object. If you do not specify the DeleteFcn property, then MATLAB executes a default deletion function.

If you specify this property as a function handle or cell array, you can access the object that is being deleted using the first argument of the callback function. Otherwise, use the gcbo function to access the object.

Callback Execution Control

BusyAction — Callback queuing

'queue' (default) | 'cancel'

Callback queuing, specified as 'queue' or 'cancel'. The BusyAction property determines how MATLAB handles the execution of interrupting callbacks. There are two callback states to consider:

• The running callback is the currently executing callback.

• The interrupting callback is a callback that tries to interrupt the running callback.

The BusyAction property determines callback queuing behavior only when both of these conditions are met:

• The running callback contains a command that processes the callback queue, such as drawnow, figure, uifigure, getframe, waitfor, or pause.

• The value of the Interruptible property of the object that owns the running callback is 'off'.

Under these conditions, the BusyAction property of the object that owns the interrupting callback determines how MATLAB handles the interrupting callback. These are possible values of the BusyAction property:

• 'queue' — Puts the interrupting callback in a queue to be processed after the running callback finishes execution.

• 'cancel' — Does not execute the interrupting callback.

BeingDeleted — Deletion status

Read-only: on/off logical value

This property is read-only.

Deletion status, returned as an on/off logical value of type matlab.lang.OnOffSwitchState.

MATLAB sets the BeingDeleted property to 'on' when the DeleteFcn callback begins execution. The BeingDeleted property remains set to 'on' until the component object no longer exists.

Check the value of the BeingDeleted property to verify that the object is not about to be deleted before querying or modifying it.

Interruptible — Callback interruption

'on' (default) | on/off logical value

Callback interruption, specified as 'on' or 'off', or as numeric or logical 1 (true) or 0 (false). A value of 'on' is equivalent to true, and 'off' is equivalent to false. Thus, you can use the value of this property as a logical value. The value is stored as an on/off logical value of type matlab.lang.OnOffSwitchState.

This property determines if a running callback can be interrupted. There are two callback states to consider:

• The running callback is the currently executing callback.

• The interrupting callback is a callback that tries to interrupt the running callback.

MATLAB determines callback interruption behavior whenever it executes a command that processes the callback queue. These commands include drawnow, figure, uifigure, getframe, waitfor, and pause.

If the running callback does not contain one of these commands, then no interruption occurs. MATLAB first finishes executing the running callback, and later executes the interrupting callback.

If the running callback does contain one of these commands, then the Interruptible property of the object that owns the running callback determines if the interruption occurs:

• If the value of Interruptible is 'off', then no interruption occurs. Instead, the BusyAction property of the object that owns the interrupting callback determines if the interrupting callback is discarded or added to the callback queue.

• If the value of Interruptible is 'on', then the interruption occurs. The next time MATLAB processes the callback queue, it stops the execution of the running callback and executes the interrupting callback. After the interrupting callback completes, MATLAB then resumes executing the running callback.

Note

Callback interruption and execution behave differently in these situations:

• If the interrupting callback is a DeleteFcn, CloseRequestFcn, or SizeChangedFcn callback, then the interruption occurs regardless of the Interruptible property value.

• If the running callback is currently executing the waitfor function, then the interruption occurs regardless of the Interruptible property value.

• If the interrupting callback is owned by a Timer object, then the callback executes according to schedule regardless of the Interruptible property value.

Note

When an interruption occurs, MATLAB does not save the state of properties or the display. For example, the object returned by the gca or gcf command might change when another callback executes.

Parent/Child

HandleVisibility — Visibility of object handle

'on' (default) | 'callback' | 'off'

Visibility of the object handle, specified as 'on', 'callback', or 'off'.

This property controls the visibility of the object in its parent's list of children. When an object is not visible in its parent's list of children, it is not returned by functions that obtain objects by searching the object hierarchy or querying properties. These functions include get, findobj, clf, and close. Objects are valid even if they are not visible. If you can access an object, you can set and get its properties, and pass it to any function that operates on objects.

HandleVisibility Value	Description
'on'	The object is always visible.
'callback'	The object is visible from within callbacks or functions invoked by callbacks, but not from within functions invoked from the command line. This option blocks access to the object at the command-line, but allows callback functions to access it.
'off'	The object is invisible at all times. This option is useful for preventing unintended changes to the UI by another function. Set the HandleVisibility to 'off' to temporarily hide the object during the execution of that function.

Parent — Parent container

Figure object (default) | Panel object | Tab object | ButtonGroup object | GridLayout object

Parent container, specified as a Figure object or one of its child containers: Tab, Panel, ButtonGroup, or GridLayout. If no container is specified, MATLAB calls the uifigure function to create a new Figure object that serves as the parent container.

Identifiers

Type — Type of graphics object

Read-only: 'uiaerohorizon'

This property is read-only.

Type of graphics object, returned as 'uiaerohorizon'.

Tag — Object identifier

'' (default) | character vector | string scalar

Object identifier, specified as a character vector or string scalar. You can specify a unique Tag value to serve as an identifier for an object. When you need access to the object elsewhere in your code, you can use the findobj function to search for the object based on the Tag value.

UserData — User data

[] (default) | array

User data, specified as any MATLAB array. For example, you can specify a scalar, vector, matrix, cell array, character array, table, or structure. Use this property to store arbitrary data on an object.

If you are working in App Designer, create public or private properties in the app to share data instead of using the UserData property. For more information, see Share Data Within App Designer Apps.

Version History

Introduced in R2018b