Package com.j3d.engine.react.events.payloads

Class SnapPayload

java.lang.Object

com.j3d.engine.react.events.EventPayload<SnapMouseOwner>

com.j3d.engine.react.events.payloads.SnapPayload

public class SnapPayload
extends EventPayload<SnapMouseOwner>

Represents an event payload specifically for snapping operations, carrying information about the GObject that is being snapped to.

This stores the GObject that is being snapped to.

Author:

Lehlogonolo Poole

See Also:

• SnapMouseOwner
• GObject

Field Summary

Fields

Modifier and Type	Field	Description
private final GObject	snap

Fields inherited from class com.j3d.engine.react.events.EventPayload

emitter

Constructor Summary

Constructors

Constructor	Description
SnapPayload(SnapMouseOwner e, GObject snap)	Default Constructor for EventPayload

Method Summary

Modifier and Type	Method	Description
GObject	getSnap()	Retrieves the GObject that this payload indicates should be snapped to.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

snap

private final GObject snap

Constructor Details

SnapPayload

public SnapPayload(SnapMouseOwner e,
 GObject snap)

Default Constructor for EventPayload

Parameters:

e - The initiator of the broadcast.

snap - The object to snap to.

Method Details

getSnap

public GObject getSnap()

Retrieves the GObject that this payload indicates should be snapped to.

Returns:

The GObject target for the snap operation.