images.roi.CircleMovingEventData class

Package: images.roi

Event data passed when the 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 (MATLAB).

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

expand all

Public Properties

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

Attributes:

GetAccess
public
SetAccess
private
GetObservable
true
SetObservable
true

Name of the event, specified as a character vector.

Attributes:

GetAccess
public
SetAccess
private
GetObservable
true
SetObservable
true

Data Types: char

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

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

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

Attributes:

GetAccess
public
SetAccess
private
GetObservable
true
SetObservable
true

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

Attributes:

GetAccess
public
SetAccess
private
GetObservable
true
SetObservable
true

Examples

collapse all

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

See Also

|

Introduced in R2018b