Difference between revisions of "DOMTransformExtended"

From Virtual World Web Wiki
Jump to: navigation, search
(Documentation for the DOMTransformExtended class)
(Documentation for the DOMTransformExtended class)
 
(13 intermediate revisions by the same user not shown)
Line 1: Line 1:
Represents a DOMTransform in JavaScript
+
Represents a [[DOMTransform]] in JavaScript
  
 
*'''Inherits class: [[DOMObjectExtended]]'''
 
*'''Inherits class: [[DOMObjectExtended]]'''
 
* This is a JavaScript visible object
 
* This is a JavaScript visible object
 
===Remarks <nowiki>[</nowiki>[{{fullurl:DOMTransformExtended Remarks|action=edit}} edit]<nowiki>]</nowiki>===
 
===Remarks <nowiki>[</nowiki>[{{fullurl:DOMTransformExtended Remarks|action=edit}} edit]<nowiki>]</nowiki>===
{{:DOMTransformExtended Remarks}}
+
{{#ifexist:DOMTransformExtended Remarks|{{:DOMTransformExtended Remarks}}|}}
  
 
===Properties===
 
===Properties===
Line 10: Line 10:
 
::
 
::
 
::The name of a bone in this node's parent's skeleton to which this object should be attached
 
::The name of a bone in this node's parent's skeleton to which this object should be attached
 
:{{CSharp|bool Clickable {get; set;} // Via attribution on DOMTransform }}
 
::
 
::Marks this object as clickable, mainly used node types derived from [[DOMRenderable]] or [[DOMVolume]]
 
 
:{{CSharp|ResourceValue Cursor {get; set;} // Via attribution on DOMTransform }}
 
::
 
::The ResourceValue for the hover-over mouse cursor to use
 
 
:{{CSharp|float CursorDistance {get; set;} // Via attribution on DOMTransform }}
 
::
 
::The distance in units before which the object can be hovered over with the mouse causing cursor change and/or tooltip activation (if configured)
 
 
:{{CSharp|bool CursorMiddleHotspot {get; set;} // Via attribution on DOMTransform }}
 
::
 
::True if the center of the cursor image should be used as the hotspot... oh dear why is this not an Point2D offset...
 
  
 
:{{CSharp|bool ExcludeTransform {get; set;} // Via attribution on DOMTransform }}
 
:{{CSharp|bool ExcludeTransform {get; set;} // Via attribution on DOMTransform }}
Line 74: Line 58:
 
::
 
::
 
::Gets or sets the transform's scale component
 
::Gets or sets the transform's scale component
 
:{{CSharp|bool Selectable {get; set;} // Via attribution on DOMTransform }}
 
::
 
::Marks this object as Selectable, mainly used node types derived from [[DOMRenderable]] or [[DOMVolume]]
 
 
:{{CSharp|bool Targetable {get; set;} // Via attribution on DOMTransform }}
 
::
 
::Marks this object as targetable, mainly used node types derived from [[DOMRenderable]] or [[DOMVolume]]
 
 
:{{CSharp|string Tooltip {get; set;} // Via attribution on DOMTransform }}
 
::
 
::The text for a hover-over tool-tip
 
 
:{{CSharp|ResourceValue TooltipIcon {get; set;} // Via attribution on DOMTransform }}
 
::
 
::The ResourceValue for a hover-over tool-tip's icon
 
 
:{{CSharp|string TooltipTitle {get; set;} // Via attribution on DOMTransform }}
 
::
 
::The text for a hover-over tool-tip's title
 
  
 
:{{CSharp|DOMTransformExtended TransformParent {get; set;} }}
 
:{{CSharp|DOMTransformExtended TransformParent {get; set;} }}
Line 106: Line 70:
 
::
 
::
 
::If this object is moving, this is how fast (in units per second)
 
::If this object is moving, this is how fast (in units per second)
 +
 +
:{{CSharp|Point3D WorldPosition {get;} // Via attribution on DOMTransform }}
  
 
:{{CSharp|float X {get; set;} // Via attribution on DOMTransform }}
 
:{{CSharp|float X {get; set;} // Via attribution on DOMTransform }}
Line 119: Line 85:
 
::Gets or sets the Z part of the transform's position component
 
::Gets or sets the Z part of the transform's position component
  
===Events===
+
===Methods===
:{{CSharp|OnClick(who, source)}}
+
:{{CSharp|DOMPhysicsApproachExtended Approach(DOMTransformExtended target)}}
::Parameters:
+
:::{{CSharp|ParticipentExtended who}} : The participant who's clicking
+
:::{{CSharp|DOMObjectExtended source}} : The object being clicked on
+
 
::
 
::
::Fires when a user clicks an object in world. Who is the Participant doing the clicking.
+
::Creates a [[DOMPhysicsApproach]] node as a direct child. The returned [[DOMPhysicsExtended]] can be used to start / stop the operation and monitor for its completion.
  
:{{CSharp|OnRightClick(who, source)}}
+
:{{CSharp|double DistanceTo(DOMTransformExtended other)}}
::Parameters:
+
:::{{CSharp|ParticipentExtended who}} : The participant who's right-clicking
+
:::{{CSharp|DOMObjectExtended source}} : The object being right-clicked on
+
 
::
 
::
::Fires when a user right-clicks an object in world. Who is the Participant doing the right-clicking.
+
::Gets the square distance between two transforms
  
===Methods===
+
:{{CSharp|DOMPhysicsFacePointExtended FacePoint(JSVector3 target, float speed)}}
:{{CSharp|bool MoveTo(float x, float y, float z, float speed, JSFlexibleFunction func {{=}} NULL)}}
+
 
::
 
::
::Moves this object smoothly, and linearly to the specified x,y,z location over time specified by speed. This is accomplished using a child DOMInterpolation node.
+
::Creates a [[DOMPhysicsFacePoint]] node as a direct child that requests this transform rotate about the Y axis to face the specified point. The returned [[DOMPhysicsExtended]] can be used to start / stop the operation and monitor for its completion.
  
:{{CSharp|DOMPhysicsExtended PathTo(float targetX, float targetY, float targetZ, float speed, JSFlexibleFunction callback {{=}} NULL)}}
+
:{{CSharp|DOMPhysicsFaceTargetExtended FaceTarget(DOMTransformExtended target, float speed {{=}} 360.0)}}
 
+
:{{CSharp|DOMPhysicsExtended PathToTarget(DOMTransformExtended target, float speed, JSFlexibleFunction callback {{=}} NULL)}}
+
 
+
:{{CSharp|DOMPhysicsExtended PathToVector(JSVector3 target, float speed, JSFlexibleFunction callback {{=}} NULL)}}
+
 
+
:{{CSharp|DOMPhysicsExtended PhysicsFollow(DOMTransformExtended target, float minDistance, float maxDistance)}}
+
 
::
 
::
::Creates a DOMPhysics node as a direct child of this node requesting the Follow operation and given the specified parameters. The returned DOMPhysics node can be used to start / stop the operation and monitor for its completion.
+
::Creates a [[DOMPhysicsFaceTarget]] node as a direct child that requests this transform rotate about the Y axis to face the specified other DOMTransform target. The returned [[DOMPhysicsExtended]] can be used to start / stop the operation and monitor for its completion.
  
:{{CSharp|DOMPhysicsExtended PhysicsFollowApproach(DOMTransformExtended target, float targetDistance, float runDistance, float abortDistance {{=}} 3.40282347E+38)}}
+
:{{CSharp|DOMPhysicsFollowExtended Follow(DOMTransformExtended target)}}
 
+
:{{CSharp|DOMPhysicsExtended PhysicsFollowPursuit(DOMTransformExtended target, float catchDistance, float escapeDistance)}}
+
 
+
:{{CSharp|DOMPhysicsExtended PhysicsFollowStayNear(DOMTransformExtended target, float minDistance, float maxDistance)}}
+
 
+
:{{CSharp|DOMPhysicsExtended PhysicsPathTo(float targetX, float targetY, float targetZ, float speed, JSFlexibleFunction callback {{=}} NULL)}}
+
 
::
 
::
::Creates a DOMPhysics node as a direct child of this node requesting the PathTo operation and given the specified parameters. The returned DOMPhysics node can be used to start / stop the operation and monitor for its completion.
+
::Creates a [[DOMPhysicsFollow]] node as a direct child. The returned [[DOMPhysicsExtended]] can be used to start / stop the operation and monitor for its completion.
  
:{{CSharp|DOMPhysicsExtended PhysicsPathToTarget(DOMTransformExtended target, float speed, JSFlexibleFunction callback {{=}} NULL)}}
+
:{{CSharp|bool MoveTo(float x, float y, float z, float speed, JSFlexibleFunction func {{=}} NULL)}}
 
+
:{{CSharp|DOMPhysicsExtended PhysicsPathToVector(JSVector3 target, float speed, JSFlexibleFunction callback {{=}} NULL)}}
+
 
::
 
::
::Creates a DOMPhysics node as a direct child of this node requesting the PathToVector operation and given the specified parameters. The returned DOMPhysics node can be used to start / stop the operation and monitor for its completion.
+
::Moves this object smoothly, and linearly to the specified x,y,z location over time specified by speed. This is accomplished using a child DOMInterpolation node.
  
:{{CSharp|DOMPhysicsExtended PhysicsProjectile(float directionX, float directionY, float directionZ, float speed, bool gravity, float maxDistance)}}
+
:{{CSharp|DOMPhysicsPathToExtended PathTo(JSVector3 target)}}
 
::
 
::
::Creates a DOMPhysics node as a direct child of this node requesting the Projectile operation and given the specified parameters. The returned DOMPhysics node can be used to start / stop the operation and monitor for its completion.
+
::Creates a [[DOMPhysicsPathTo]] node as a direct child that requests this transform be smoothly pathed to the specified coordinates. The returned [[DOMPhysicsExtended]] can be used to start / stop the operation and monitor for its completion.
  
:{{CSharp|DOMPhysicsExtended PhysicsProjectileVector(JSVector3 direction, float speed, bool gravity, float maxDistance)}}
+
:{{CSharp|DOMPhysicsPursueExtended Pursue(DOMTransformExtended target)}}
 
::
 
::
::Creates a DOMPhysics node as a direct child of this node requesting the ProjectileVector operation and given the specified parameters. The returned DOMPhysics node can be used to start / stop the operation and monitor for its completion.
+
::Creates a [[DOMPhysicsPursue]] node as a direct child. The returned [[DOMPhysicsExtended]] can be used to start / stop the operation and monitor for its completion.
 
+
:{{CSharp|DOMPhysicsExtended PhysicsSpawn(float radius, bool stack)}}
+
::
+
::Creates a DOMPhysics node as a direct child of this node requesting the Spawn operation and given the specified parameters. The returned DOMPhysics node can be used to start / stop the operation and monitor for its completion.
+
  
 
:{{CSharp|void ResetTransformParent(bool restoreLastPosition {{=}} false)}}
 
:{{CSharp|void ResetTransformParent(bool restoreLastPosition {{=}} false)}}
Line 182: Line 123:
  
 
:{{CSharp|bool RotateTo(float x, float y, float z, float speed, JSFlexibleFunction func {{=}} NULL)}}
 
:{{CSharp|bool RotateTo(float x, float y, float z, float speed, JSFlexibleFunction func {{=}} NULL)}}
 
:{{CSharp|DOMPhysicsExtended RotateToFaceTarget(DOMTransformExtended target, float speed, JSFlexibleFunction callback {{=}} NULL)}}
 
  
 
:{{CSharp|void SetPosition(float x, float y, float z)}}
 
:{{CSharp|void SetPosition(float x, float y, float z)}}
Line 200: Line 139:
 
::
 
::
 
::Sets this objects transform parent reference to the specified DOMTransform preventing it from transforming relative to the next DOMTransform up the hierarchy, but rather, the specified object instead. Sets the position, rotation, and scale to new values along with the transform parent change as a single atomic operation.
 
::Sets this objects transform parent reference to the specified DOMTransform preventing it from transforming relative to the next DOMTransform up the hierarchy, but rather, the specified object instead. Sets the position, rotation, and scale to new values along with the transform parent change as a single atomic operation.
 +
 +
:{{CSharp|DOMPhysicsSpawnAreaExtended SpawnArea(float radius, DOMTransformExtended target {{=}} NULL)}}
 +
::
 +
::Creates a [[DOMPhysicsSpawnArea]] node as a direct child requesting the Spawn operation and given the specified parameters.
 +
 +
:{{CSharp|DOMPhysicsSpawnAtExtended SpawnAt(float radius, float angle, DOMTransformExtended target {{=}} NULL)}}
 +
::
 +
::Creates a [[DOMPhysicsSpawnAt]] node as a direct child requesting the Spawn operation and given the specified parameters.
  
 
__NOTOC____NOEDITSECTION__
 
__NOTOC____NOEDITSECTION__

Latest revision as of 15:35, 20 September 2019

Represents a DOMTransform in JavaScript

Remarks [edit]

Properties

string AttachToBone {get; set;} // Via attribution on DOMTransform
The name of a bone in this node's parent's skeleton to which this object should be attached
bool ExcludeTransform {get; set;} // Via attribution on DOMTransform
When true, this transform's value is excluded when calculating child node transforms
Point3D Position {get; set;} // Via attribution on DOMTransform
Gets or sets the transform's position component
float RX {get; set;} // Via attribution on DOMTransform
Gets or sets the X part of the transform's rotation component
float RY {get; set;} // Via attribution on DOMTransform
Gets or sets the Y part of the transform's rotation component
float RZ {get; set;} // Via attribution on DOMTransform
Gets or sets the Z part of the transform's rotation component
Point3D Rotation {get; set;} // Via attribution on DOMTransform
Gets or sets the transform's rotation component
Point3D RotationAxis {get; set;} // Via attribution on DOMTransform
A normal expressing the direction of rotation
float RotationSpeed {get; set;} // Via attribution on DOMTransform
The speed by which to multiply the RotationAxis
float SX {get; set;} // Via attribution on DOMTransform
Gets or sets the X part of the transform's scale component
float SY {get; set;} // Via attribution on DOMTransform
Gets or sets the Y part of the transform's scale component
float SZ {get; set;} // Via attribution on DOMTransform
Gets or sets the Z part of the transform's scale component
Point3D Scale {get; set;} // Via attribution on DOMTransform
Gets or sets the transform's scale component
DOMTransformExtended TransformParent {get; set;}
Gets a reference to this object’s DOMTransform parent, if it has been set to something other than normal node hierarchy.
long TransformParentID {get; set;} // Via attribution on DOMTransform
Sets the ID of another object in the same view that will be used as this object's transform parent instead of the object's natural position in the DOM hierarchy
Point3D Velocity {get; set;} // Via attribution on DOMTransform
If this object is moving, this is how fast (in units per second)
Point3D WorldPosition {get;} // Via attribution on DOMTransform
float X {get; set;} // Via attribution on DOMTransform
Gets or sets the X part of the transform's position component
float Y {get; set;} // Via attribution on DOMTransform
Gets or sets the Y part of the transform's position component
float Z {get; set;} // Via attribution on DOMTransform
Gets or sets the Z part of the transform's position component

Methods

DOMPhysicsApproachExtended Approach(DOMTransformExtended target)
Creates a DOMPhysicsApproach node as a direct child. The returned DOMPhysicsExtended can be used to start / stop the operation and monitor for its completion.
double DistanceTo(DOMTransformExtended other)
Gets the square distance between two transforms
DOMPhysicsFacePointExtended FacePoint(JSVector3 target, float speed)
Creates a DOMPhysicsFacePoint node as a direct child that requests this transform rotate about the Y axis to face the specified point. The returned DOMPhysicsExtended can be used to start / stop the operation and monitor for its completion.
DOMPhysicsFaceTargetExtended FaceTarget(DOMTransformExtended target, float speed = 360.0)
Creates a DOMPhysicsFaceTarget node as a direct child that requests this transform rotate about the Y axis to face the specified other DOMTransform target. The returned DOMPhysicsExtended can be used to start / stop the operation and monitor for its completion.
DOMPhysicsFollowExtended Follow(DOMTransformExtended target)
Creates a DOMPhysicsFollow node as a direct child. The returned DOMPhysicsExtended can be used to start / stop the operation and monitor for its completion.
bool MoveTo(float x, float y, float z, float speed, JSFlexibleFunction func = NULL)
Moves this object smoothly, and linearly to the specified x,y,z location over time specified by speed. This is accomplished using a child DOMInterpolation node.
DOMPhysicsPathToExtended PathTo(JSVector3 target)
Creates a DOMPhysicsPathTo node as a direct child that requests this transform be smoothly pathed to the specified coordinates. The returned DOMPhysicsExtended can be used to start / stop the operation and monitor for its completion.
DOMPhysicsPursueExtended Pursue(DOMTransformExtended target)
Creates a DOMPhysicsPursue node as a direct child. The returned DOMPhysicsExtended can be used to start / stop the operation and monitor for its completion.
void ResetTransformParent(bool restoreLastPosition = false)
Resets this object’s transform parent reference to null so that it behaves normaly, transforming relative to the next DOMTransform up the hierarchy.
bool RotateTo(float x, float y, float z, float speed, JSFlexibleFunction func = NULL)
void SetPosition(float x, float y, float z)
Sets the position (transform) of this object from its next parent DOMTransform or from world origin (0,0,0).
void SetRotation(float x, float y, float z)
Sets the rotation of this object relative to its next parent DOMTransform or from (0,0,0)
void SetScale(float x, float y, float z)
Sets the scale of this object relative to its next parent DOMTransform or from (1,1,1)
void SetTransformParent(DOMTransformExtended target, JSVector3 position = NULL, JSVector3 rotation = NULL, JSVector3 scale = NULL)
Sets this objects transform parent reference to the specified DOMTransform preventing it from transforming relative to the next DOMTransform up the hierarchy, but rather, the specified object instead. Sets the position, rotation, and scale to new values along with the transform parent change as a single atomic operation.
DOMPhysicsSpawnAreaExtended SpawnArea(float radius, DOMTransformExtended target = NULL)
Creates a DOMPhysicsSpawnArea node as a direct child requesting the Spawn operation and given the specified parameters.
DOMPhysicsSpawnAtExtended SpawnAt(float radius, float angle, DOMTransformExtended target = NULL)
Creates a DOMPhysicsSpawnAt node as a direct child requesting the Spawn operation and given the specified parameters.