Package | net.user1.reactor.motion |
Class | public class PointerPositionBroadcaster |
Inheritance | PointerPositionBroadcaster ![]() |
Since : | ReactorGUI 1.0.0 |
See also
Variable | Defined By | ||
---|---|---|---|
DEFAULT_SAMPLE_RATE : int = 50 [static] | PointerPositionBroadcaster |
Method | Defined By | ||
---|---|---|---|
PointerPositionBroadcaster(reactor:Reactor, positionTarget:DisplayObject, sampleRate:int = 50, sendRate:int = 300, scope:String = null)
Constructor
| PointerPositionBroadcaster | ||
dispose():void
Disposes of the resources used by this object, preparing it for garbage
collection. | PointerPositionBroadcaster | ||
getPositionListAttributeName():String
Returns the attribute name used by this PointerPositionBroadcaster to send
position list updates to other clients. | PointerPositionBroadcaster | ||
setPositionListAttributeName(name:String):void
Specifies the attribute name used by this PointerPositionBroadcaster to send
position list updates to other clients. | PointerPositionBroadcaster | ||
start():void
Enables position-list broadcasts. | PointerPositionBroadcaster | ||
stop():void
Disables position-list broadcasts. | PointerPositionBroadcaster |
DEFAULT_SAMPLE_RATE | variable |
public static var DEFAULT_SAMPLE_RATE:int = 50
PointerPositionBroadcaster | () | Constructor |
public function PointerPositionBroadcaster(reactor:Reactor, positionTarget:DisplayObject, sampleRate:int = 50, sendRate:int = 300, scope:String = null)
Since : | ReactorGUI 1.0.0 |
Constructor
Parametersreactor:Reactor — The Reactor object through which position list updates
will be sent.
| |
positionTarget:DisplayObject — The display object relative to which mouse positions
will be sampled.
| |
sampleRate:int (default = 50 ) — The rate at which to collect mouse position samples.
| |
sendRate:int (default = 300 ) — The rate at which to send position list updates.
| |
scope:String (default = null ) — The attribute scope for position list updates. To limit
position-list recipients to a single room, set
scope to that room (e.g.,
"examples.avatarchat").
|
dispose | () | method |
public function dispose():void
Since : | ReactorGUI 1.0.0 |
Disposes of the resources used by this object, preparing it for garbage collection.
getPositionListAttributeName | () | method |
public function getPositionListAttributeName():String
Since : | ReactorGUI 1.0.0 |
Returns the attribute name used by this PointerPositionBroadcaster to send position list updates to other clients.
ReturnsString |
setPositionListAttributeName | () | method |
public function setPositionListAttributeName(name:String):void
Since : | ReactorGUI 1.0.0 |
Specifies the attribute name used by this PointerPositionBroadcaster to send position list updates to other clients.
Parameters
name:String |
start | () | method |
public function start():void
Since : | ReactorGUI 1.0.0 |
Enables position-list broadcasts. Note that if Reactor is not currently connected to Union, no updates are sent, even if the PositionBroadcaster is enabled.
stop | () | method |
public function stop():void
Since : | ReactorGUI 1.0.0 |
Disables position-list broadcasts.