Main Content

images.ui.graphics.events.ClippingPlanesChangedEventData Class

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

Event data is passed when clipping plane is being interactively moved

Renamed from images.ui.graphics3d.events.ClippingPlanesChangedEventData in R2024b

expand all in page

Description

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

The images.ui.graphics.events.ClippingPlanesChangedEventData 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 ClippingPlanesChangedEventData object when called to trigger an event.

Properties

expand all

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

Clipping planes, specified as an N-by-4 matrix where each row corresponds to the equation for a clipping plane. The maximum number of clipping planes N is 6. Each clipping 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

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

Attributes:

GetAccess
public
SetAccess
private
GetObservable
true
SetObservable
true

Data Types: char

Examples

collapse all

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

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

Version History

Introduced in R2022b

expand all

See Also

| |