images.roi.CircleMovingEventData Class

Namespace: images.roi

Event data passed when circle ROI is moving

Description

The images.roi.CircleMovingEventData class is the class passed to listeners when a Circle 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.CircleMovingEventData object and passes that object to the listener callback function (the event handler).

The images.roi.CircleMovingEventData 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.CircleMovingEventData object when called to trigger an event. images.roi.CircleMovingEventData 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

Data Types: char

PreviousCenter — Position before ROI moved

two-element numeric vector

Position before ROI moved, specified as a two-element numeric vector of the form [x y].

Attributes:

GetAccess	public
SetAccess	private
GetObservable	true
SetObservable	true

CurrentCenter — Position after ROI moved

two-element numeric vector

Position after ROI moved, specified as a two-element numeric vector of the form [x y].

Attributes:

GetAccess	public
SetAccess	private
GetObservable	true
SetObservable	true

PreviousRadius — Radius before change in size

numeric scalar

Radius before change in size, specified as a numeric scalar.

Attributes:

GetAccess	public
SetAccess	private
GetObservable	true
SetObservable	true

CurrentRadius — Radius after change in size

numeric scalar

Radius after change in size, specified as a numeric scalar.

Attributes:

GetAccess	public
SetAccess	private
GetObservable	true
SetObservable	true

Examples

Access Event Data

This callback function gets the event source object handle and the event name and other properties from the images.roi.CircleMovingEventData 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; 
   previousRadius = evtData.PreviousRadius;
   currentRadius = evtData.CurrentRadius;
end

Version History

Introduced in R2018b