images.ui.graphics3d.events.CropRegionChangedEventData Class

Namespace: images.ui.graphics3d.events
Superclasses: event.EventData

Event data is passed when crop region is changed

Since R2023b

Description

The images.ui.graphics3d.events.CropRegionChangedEventData class is the class passed to listeners when you interactively change the crop region within a Viewer3D object. When the object triggers an event using the notify handle class method, MATLAB^® assigns values to the properties of a CropRegionChangedEventData object and passes that object to the listener callback function (the event handler).

The images.ui.graphics3d.events.CropRegionChangedEventData 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 a CropRegionEventData object when called to trigger an event.

Properties

Source — Event source

Viewer3D object

Event source, specified as a handle to the Viewer3D 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

CropRegion — Current position of crop region

2-by-3 numeric matrix

Current position of the crop region, specified as a 2-by-3 numeric matrix of the form [xmin ymin zmin; xmax ymax zmax], where the first and second rows specify the minimum and maximum coordinates of the crop region, respectively.

Attributes:

GetAccess	public
SetAccess	private
GetObservable	true
SetObservable	true

PreviousCropRegion — Previous position of crop region

2-by-3 numeric matrix

Previous position of the crop region, specified as a 2-by-3 numeric matrix of the form [xmin ymin zmin; xmax ymax zmax], where the first and second rows specify the minimum and maximum coordinates of the crop region, respectively.

Attributes:

GetAccess	public
SetAccess	private
GetObservable	true
SetObservable	true

Examples

Access Event Data

This code defines a callback function that gets the event properties from the images.ui.graphics3d.events.CropRegionChangedEventData object passed to it when the event is triggered.

function myCallbk(s,evtData)
   eventSource = evtData.Source;
   eventName = evtData.EventName;
   eventCurrPos = evtData.CropRegion;
   eventPrevPos = evtData.PreviousCropRegion;
   ...
end

Version History

Introduced in R2023b