images.roi.CuboidMovingEventData Class

Namespace: images.roi

Event data passed when cuboid ROI is moving

Description

The images.roi.CuboidMovingEventData class is the class passed to listeners when a Cuboid ROI is moving. When the ROI class triggers an event using the notify handle class method, MATLAB^® assigns values to the properties of an images.roi.CuboidMovingEventData object and passes that object to the listener callback function (the event handler).

The images.roi.CuboidMovingEventData class is a handle class.

Class Attributes

ConstructOnLoad	true
HandleCompatible	true

For information on class attributes, see Class Attributes.

Creation

The notify handle class method creates an images.roi.CuboidMovingEventData object when called to trigger an event. images.roi.CuboidMovingEventData accepts no input arguments.

Properties

Source — Event source

object

Event source, specified as a handle to the object that triggered the event.

Attributes:

GetAccess	public
SetAccess	private
GetObservable	true
SetObservable	true

EventName — Name of event

character vector

Name of the event, specified as a character vector.

Attributes:

GetAccess	public
SetAccess	private
GetObservable	true
SetObservable	true

PreviousPosition — Position before ROI moved

1-by-6 numeric array

Position before ROI moved, specified as a 1-by-6 numeric array of the form [x y z w h d].

Attributes:

GetAccess	public
SetAccess	private
GetObservable	true
SetObservable	true

CurrentPosition — Position after ROI moved

1-by-6 numeric array

Position after ROI moved, specified as a 1-by-6 numeric array of the form [x y z w h d].

Attributes:

GetAccess	public
SetAccess	private
GetObservable	true
SetObservable	true

PreviousRotationAngle — Orientation before ROI rotated

1-by-3 numeric array

Orientation before ROI rotated, specified as a 1-by-3 numeric array, measured in degrees.

Attributes:

GetAccess	public
SetAccess	private
GetObservable	true
SetObservable	true

CurrentRotationAngle — Orientation after ROI rotated

1-by-3 numeric array

Orientation after ROI rotated, specified as a 1-by-3 numeric array, measured in degrees.

Attributes:

GetAccess	public
SetAccess	private
GetObservable	true
SetObservable	true

Examples

Access Event Data

This callback function gets the event source object handle, the event name, and other properties from the images.roi.CuboidMovingEventData object passed to it when the event is triggered.

function myCallbk(s,evtData)
   eventSource = evtData.Source;
   eventName = evtData.EventName;
   previousCenter = evtData.PreviousCenter;
   currentCenter = evtData.CurrentCenter; 
   previousRotationAngle = evtData.PreviousRotationAngle;
   currentRotationAngle = evtData.CurrentRotationAngle;
end

Version History

Introduced in R2019a