images.ui.graphics3d.events.SlicePlanesChangedEventData class

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

Event data is passed when slice plane is being interactively moved

Since R2022b

Description

The images.ui.graphics3d.events.SlicePlanesChangedEventData class is the class passed to listeners when the slice planes of a Volume object is moving. When the object triggers an event using the notify handle class method, MATLAB^® assigns values to the properties of a SlicePlanesChangedEventData object and passes that object to the listener callback function (the event handler).

The images.ui.graphics3d.events.SlicePlanesChangedEventData 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 SlicePlanesChangedEventData object when called to trigger an event. SlicePlanesChangedEventData accepts no input arguments.

Properties

Source — Event source

Volume object

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

SlicePlanes — Slice planes

N-by-4 matrix

Slice planes, specified as an N-by-4 matrix where each row corresponds to the equation for a slice plane. The maximum number of slice planes N is 6. Each slice plane is specified as a 1-by-4 vector in world coordinates following the Hessian normal form where the first three values represent the plane's normal vector and the fourth value is the signed distance from the origin to the plane.

Attributes:

GetAccess	public
SetAccess	private
GetObservable	true
SetObservable	true

Data Types: char

PreviousSlicePlanes — Previous slice planes

N-by-4 matrix

Previous slice planes, specified as an N-by-4 matrix where each row corresponds to the equation for a slice plane.

Attributes:

GetAccess	public
SetAccess	private
GetObservable	true
SetObservable	true

Data Types: char

Examples

Access Event Data

Get the event properties from the images.ui.graphics3d.events.SlicePlanesChangedEventData object passed to this callback function when the event is triggered.

function myCallbk(s,evtData)
   eventSource = evtData.Source;
   eventName = evtData.EventName;
   currPlanes = evtData.SlicePlanes;
   prevPlanes = evtData.PreviousSlicePlanes;
   ...
end

Version History

Introduced in R2022b