images.ui.graphics3d.events.AnnotationAddedEventData Class

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

Event data is passed when annotation is added

Since R2024a

Description

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

The images.ui.graphics3d.events.AnnotationAddedEventData 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 AnnotationAddedEventData 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

Annotation — Annotation added to viewer

Point object | Line object

Annotation added to the viewer, specified as a Point or Line object. Each Point object specifies a 3-D point annotation, and each Line object specifies a 3-D line annotation.

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.AnnotationAddedEventData object passed to it when the event is triggered.

function myCallbk(s,evtData)
   eventSource = evtData.Source;
   eventName = evtData.EventName;
   eventAnnotation = evtData.Annotation;
   ...
end

Version History

Introduced in R2024a