Difference between revisions of "DOMVolumeExtended"
From Virtual World Web Wiki
(Documentation for the DOMVolumeExtended class) |
(Documentation for the DOMVolumeExtended class) |
||
(11 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
− | Represents a DOMVolume in JavaScript | + | Represents a [[DOMVolume]] in JavaScript |
− | *'''Inherits class: [[ | + | *'''Inherits class: [[DOMGeometryExtended]]''' |
* This is a JavaScript visible object | * This is a JavaScript visible object | ||
===Remarks <nowiki>[</nowiki>[{{fullurl:DOMVolumeExtended Remarks|action=edit}} edit]<nowiki>]</nowiki>=== | ===Remarks <nowiki>[</nowiki>[{{fullurl:DOMVolumeExtended Remarks|action=edit}} edit]<nowiki>]</nowiki>=== | ||
− | {{:DOMVolumeExtended Remarks}} | + | {{#ifexist:DOMVolumeExtended Remarks|{{:DOMVolumeExtended Remarks}}|}} |
===Properties=== | ===Properties=== | ||
− | |||
− | |||
:{{CSharp|Point3D Size {get; set;} // Via attribution on DOMVolume }} | :{{CSharp|Point3D Size {get; set;} // Via attribution on DOMVolume }} | ||
+ | :: | ||
+ | ::The size of the volume box | ||
===Events=== | ===Events=== | ||
− | :{{CSharp|OnEnter( | + | :{{CSharp|OnEnter(ParticipantExtended who, DOMObjectExtended source)}} |
+ | ::Parameters: | ||
+ | :::{{CSharp|who}} : The participant entering the volume | ||
+ | :::{{CSharp|source}} : The volume being entered | ||
+ | :: | ||
+ | ::Fires when a user enters this DOMVolume in world. Who is the Participant doing the entering. | ||
+ | |||
+ | :{{CSharp|OnLeave(ParticipantExtended who, DOMObjectExtended source)}} | ||
+ | ::Parameters: | ||
+ | :::{{CSharp|who}} : The participant leaving the volume | ||
+ | :::{{CSharp|source}} : The volume being left | ||
+ | :: | ||
+ | ::Fires when a user leaves this DOMVolume in world. Who is the Participant doing the entering. | ||
+ | |||
+ | :{{CSharp|OnObjectEnter(DOMObjectExtended what, DOMObjectExtended source)}} | ||
+ | ::Parameters: | ||
+ | :::{{CSharp|what}} : The [[DOMCollider]] doing the entering. Or if the collider was automatically added and not represented in the DOM, the object to which the collider is attached. | ||
+ | :::{{CSharp|source}} : The volume being entered | ||
:: | :: | ||
− | ::Fires when a | + | ::Fires when a collider (that is not another participant, see OnEnter instead) enters this DOMVolume in world. 'What' is the object or [[DOMCollider]] doing the entering. |
− | :{{CSharp| | + | :{{CSharp|OnObjectLeave(DOMObjectExtended what, DOMObjectExtended source)}} |
+ | ::Parameters: | ||
+ | :::{{CSharp|what}} : The [[DOMCollider]] doing the leaving. Or if the collider was automatically added and not represented in the DOM, the object to which the collider is attached. | ||
+ | :::{{CSharp|source}} : The volume being left | ||
:: | :: | ||
− | ::Fires when a | + | ::Fires when a collider (that is not another participant, see OnLeave instead) leaves this DOMVolume in world. 'What' is the object or [[DOMCollider]] doing the leaving. |
__NOTOC____NOEDITSECTION__ | __NOTOC____NOEDITSECTION__ |
Latest revision as of 12:10, 30 April 2019
Represents a DOMVolume in JavaScript
- Inherits class: DOMGeometryExtended
- This is a JavaScript visible object
Remarks [edit]
Properties
- Point3D Size {get; set;} // Via attribution on DOMVolume
- The size of the volume box
Events
- OnEnter(ParticipantExtended who, DOMObjectExtended source)
- Parameters:
- who : The participant entering the volume
- source : The volume being entered
- Fires when a user enters this DOMVolume in world. Who is the Participant doing the entering.
- Parameters:
- OnLeave(ParticipantExtended who, DOMObjectExtended source)
- Parameters:
- who : The participant leaving the volume
- source : The volume being left
- Fires when a user leaves this DOMVolume in world. Who is the Participant doing the entering.
- Parameters:
- OnObjectEnter(DOMObjectExtended what, DOMObjectExtended source)
- Parameters:
- what : The DOMCollider doing the entering. Or if the collider was automatically added and not represented in the DOM, the object to which the collider is attached.
- source : The volume being entered
- Fires when a collider (that is not another participant, see OnEnter instead) enters this DOMVolume in world. 'What' is the object or DOMCollider doing the entering.
- Parameters:
- OnObjectLeave(DOMObjectExtended what, DOMObjectExtended source)
- Parameters:
- what : The DOMCollider doing the leaving. Or if the collider was automatically added and not represented in the DOM, the object to which the collider is attached.
- source : The volume being left
- Fires when a collider (that is not another participant, see OnLeave instead) leaves this DOMVolume in world. 'What' is the object or DOMCollider doing the leaving.
- Parameters: