Difference between revisions of "DOMVolumeExtended"

From Virtual World Web Wiki
Jump to: navigation, search
(Documentation for the DOMVolumeExtended class)
(Documentation for the DOMVolumeExtended class)
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
Represents a DOMVolume in JavaScript
+
Represents a [[DOMVolume]] in JavaScript
  
*'''Inherits class: [[DOMTransformExtended]]'''
+
*'''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>===
Line 7: Line 7:
  
 
===Properties===
 
===Properties===
:{{CSharp|float InteractionDistance {get; set;} // Via attribution on DOMVolume }}
 
::
 
::The maximum distance, beyond which a user cannot mousover or click on the volume
 
 
 
:{{CSharp|Point3D Size {get; set;} // Via attribution on DOMVolume }}
 
:{{CSharp|Point3D Size {get; set;} // Via attribution on DOMVolume }}
 
::
 
::
Line 21: Line 17:
 
:::{{CSharp|source}} : The volume being entered
 
:::{{CSharp|source}} : The volume being entered
 
::
 
::
::Fires when a user enters an DOMVolume in world. Who is the Participant doing the entering.
+
::Fires when a user enters this DOMVolume in world. Who is the Participant doing the entering.
  
 
:{{CSharp|OnLeave(ParticipantExtended who, DOMObjectExtended source)}}
 
:{{CSharp|OnLeave(ParticipantExtended who, DOMObjectExtended source)}}
Line 28: Line 24:
 
:::{{CSharp|source}} : The volume being left
 
:::{{CSharp|source}} : The volume being left
 
::
 
::
::Fires when a user leaves an DOMVolume in world. Who is the Participant doing the entering.
+
::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 collider (that is not another participant, see OnEnter instead) enters this DOMVolume in world. 'What' is the object or [[DOMCollider]] doing the entering.
 +
 
 +
:{{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 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

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.
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.
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.
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.