Difference between revisions of "DOMTransformExtended"

From Virtual World Web Wiki
Jump to: navigation, search
(Documentation for the DOMTransformExtended class)
 
(Documentation for the DOMTransformExtended class)
 
(22 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
* '''Inherits class: [[DOMObjectExtended]]'''
+
Represents a [[DOMTransform]] in JavaScript
 +
 
 +
*'''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===
−
:{{CSharp|string AttachToBone {get; set;} // Via attribution [[DOMTransform]] }}
+
:{{CSharp|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
 
::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 [[DOMTransform]] }}
+
:{{CSharp|bool ExcludeTransform {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 [[DOMTransform]] }}
+
−
::
+
−
::The ResourceValue for the hover-over mouse cursor to use
+
−
 
+
−
:{{CSharp|Single CursorDistance {get; set;} // Via attribution [[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 [[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 [[DOMTransform]] }}
+
 
::
 
::
 
::When true, this transform's value is excluded when calculating child node transforms
 
::When true, this transform's value is excluded when calculating child node transforms
  
−
:{{CSharp|Point3D Position {get; set;} // Via attribution [[DOMTransform]] }}
+
:{{CSharp|Point3D Position {get; set;} // Via attribution on DOMTransform }}
 
::
 
::
 
::Gets or sets the transform's position component
 
::Gets or sets the transform's position component
  
−
:{{CSharp|Single RX {get; set;} // Via attribution [[DOMTransform]] }}
+
:{{CSharp|float RX {get; set;} // Via attribution on DOMTransform }}
 
::
 
::
 
::Gets or sets the X part of the transform's rotation component
 
::Gets or sets the X part of the transform's rotation component
  
−
:{{CSharp|Single RY {get; set;} // Via attribution [[DOMTransform]] }}
+
:{{CSharp|float RY {get; set;} // Via attribution on DOMTransform }}
 
::
 
::
 
::Gets or sets the Y part of the transform's rotation component
 
::Gets or sets the Y part of the transform's rotation component
  
−
:{{CSharp|Single RZ {get; set;} // Via attribution [[DOMTransform]] }}
+
:{{CSharp|float RZ {get; set;} // Via attribution on DOMTransform }}
 
::
 
::
 
::Gets or sets the Z part of the transform's rotation component
 
::Gets or sets the Z part of the transform's rotation component
  
−
:{{CSharp|Point3D Rotation {get; set;} // Via attribution [[DOMTransform]] }}
+
:{{CSharp|Point3D Rotation {get; set;} // Via attribution on DOMTransform }}
 
::
 
::
 
::Gets or sets the transform's rotation component
 
::Gets or sets the transform's rotation component
  
−
:{{CSharp|Point3D RotationAxis {get; set;} // Via attribution [[DOMTransform]] }}
+
:{{CSharp|Point3D RotationAxis {get; set;} // Via attribution on DOMTransform }}
 
::
 
::
 
::A normal expressing the direction of rotation
 
::A normal expressing the direction of rotation
  
−
:{{CSharp|Single RotationSpeed {get; set;} // Via attribution [[DOMTransform]] }}
+
:{{CSharp|float RotationSpeed {get; set;} // Via attribution on DOMTransform }}
 
::
 
::
 
::The speed by which to multiply the RotationAxis
 
::The speed by which to multiply the RotationAxis
  
−
:{{CSharp|Single SX {get; set;} // Via attribution [[DOMTransform]] }}
+
:{{CSharp|float SX {get; set;} // Via attribution on DOMTransform }}
 
::
 
::
 
::Gets or sets the X part of the transform's scale component
 
::Gets or sets the X part of the transform's scale component
  
−
:{{CSharp|Single SY {get; set;} // Via attribution [[DOMTransform]] }}
+
:{{CSharp|float SY {get; set;} // Via attribution on DOMTransform }}
 
::
 
::
 
::Gets or sets the Y part of the transform's scale component
 
::Gets or sets the Y part of the transform's scale component
  
−
:{{CSharp|Single SZ {get; set;} // Via attribution [[DOMTransform]] }}
+
:{{CSharp|float SZ {get; set;} // Via attribution on DOMTransform }}
 
::
 
::
 
::Gets or sets the Z part of the transform's scale component
 
::Gets or sets the Z part of the transform's scale component
  
−
:{{CSharp|Point3D Scale {get; set;} // Via attribution [[DOMTransform]] }}
+
:{{CSharp|Point3D Scale {get; set;} // Via attribution on DOMTransform }}
 
::
 
::
 
::Gets or sets the transform's scale component
 
::Gets or sets the transform's scale component
  
−
:{{CSharp|bool Selectable {get; set;} // Via attribution [[DOMTransform]] }}
+
:{{CSharp|DOMTransformExtended TransformParent {get; set;} }}
 
::
 
::
−
::Marks this object as Selectable, mainly used node types derived from [[DOMRenderable]] or [[DOMVolume]]
+
::Gets a reference to this object’s DOMTransform parent, if it has been set to something other than normal node hierarchy.
  
−
:{{CSharp|bool Targetable {get; set;} // Via attribution [[DOMTransform]] }}
+
:{{CSharp|long TransformParentID {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 [[DOMTransform]] }}
+
−
::
+
−
::The text for a hover-over tool-tip
+
−
 
+
−
:{{CSharp|ResourceValue TooltipIcon {get; set;} // Via attribution [[DOMTransform]] }}
+
−
::
+
−
::The ResourceValue for a hover-over tool-tip's icon
+
−
 
+
−
:{{CSharp|string TooltipTitle {get; set;} // Via attribution [[DOMTransform]] }}
+
−
::
+
−
::The text for a hover-over tool-tip's title
+
−
 
+
−
:{{CSharp|DOMTransformExtended TransformParent {get; set;} }}
+
−
 
+
−
:{{CSharp|long TransformParentID {get; set;} // Via attribution [[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
 
::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
  
−
:{{CSharp|Point3D Velocity {get; set;} // Via attribution [[DOMTransform]] }}
+
:{{CSharp|Point3D Velocity {get; set;} // Via attribution on DOMTransform }}
 
::
 
::
 
::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|Single X {get; set;} // Via attribution [[DOMTransform]] }}
+
:{{CSharp|Point3D WorldPosition {get;} // Via attribution on DOMTransform }}
 +
 
 +
:{{CSharp|float X {get; set;} // Via attribution on DOMTransform }}
 
::
 
::
 
::Gets or sets the X part of the transform's position component
 
::Gets or sets the X part of the transform's position component
  
−
:{{CSharp|Single Y {get; set;} // Via attribution [[DOMTransform]] }}
+
:{{CSharp|float Y {get; set;} // Via attribution on DOMTransform }}
 
::
 
::
 
::Gets or sets the Y part of the transform's position component
 
::Gets or sets the Y part of the transform's position component
  
−
:{{CSharp|Single Z {get; set;} // Via attribution [[DOMTransform]] }}
+
:{{CSharp|float Z {get; set;} // Via attribution on DOMTransform }}
 
::
 
::
 
::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===
 
−
:{{CSharp|OnClick(EventHandler<FlexibleEventArgs>)}}
 
−
 
−
:{{CSharp|OnRightClick(EventHandler<FlexibleEventArgs>)}}
 
  
 
===Methods===
 
===Methods===
−
:{{CSharp|bool MoveTo(Single x, Single y, Single z, Single speed, JSFlexibleFunction func)}}
+
:{{CSharp|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.
  
−
:{{CSharp|ReturnType PathTo(Single targetX, Single targetY, Single targetZ, Single speed, JSFlexibleFunction callback)}}
+
:{{CSharp|double DistanceTo(DOMTransformExtended other)}}
 +
::
 +
::Gets the square distance between two transforms
  
−
:{{CSharp|ReturnType PathToTarget(DOMTransformExtended target, Single speed, JSFlexibleFunction callback)}}
+
:{{CSharp|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.
  
−
:{{CSharp|ReturnType PathToVector(JSVector3 target, Single speed, JSFlexibleFunction callback)}}
+
:{{CSharp|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.
  
−
:{{CSharp|ReturnType PhysicsFollow(DOMTransformExtended target, Single minDistance, Single maxDistance)}}
+
:{{CSharp|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.
  
−
:{{CSharp|ReturnType PhysicsPathTo(Single targetX, Single targetY, Single targetZ, Single speed, JSFlexibleFunction callback)}}
+
:{{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.
  
−
:{{CSharp|ReturnType PhysicsPathToTarget(DOMTransformExtended target, Single speed, JSFlexibleFunction callback)}}
+
:{{CSharp|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.
  
−
:{{CSharp|ReturnType PhysicsPathToVector(JSVector3 target, Single speed, JSFlexibleFunction callback)}}
+
:{{CSharp|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.
  
−
:{{CSharp|ReturnType PhysicsProjectile(Single directionX, Single directionY, Single directionZ, Single speed, bool gravity, Single maxDistance)}}
+
:{{CSharp|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.
  
−
:{{CSharp|ReturnType PhysicsProjectileVector(JSVector3 direction, Single speed, bool gravity, Single maxDistance)}}
+
:{{CSharp|bool RotateTo(float x, float y, float z, float speed, JSFlexibleFunction func {{=}} NULL)}}
  
−
:{{CSharp|ReturnType PhysicsSpawn(Single radius, bool stack)}}
+
:{{CSharp|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).
  
−
:{{CSharp|ReturnType ResetTransformParent(bool restoreLastPosition)}}
+
:{{CSharp|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)
  
−
:{{CSharp|bool RotateTo(Single x, Single y, Single z, Single speed, JSFlexibleFunction func)}}
+
:{{CSharp|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)
  
−
:{{CSharp|ReturnType RotateToFaceTarget(DOMTransformExtended target, Single speed, JSFlexibleFunction callback)}}
+
:{{CSharp|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.
  
−
:{{CSharp|ReturnType SetPosition(Single x, Single y, Single z)}}
+
:{{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|ReturnType SetRotation(Single x, Single y, Single z)}}
+
:{{CSharp|DOMPhysicsSpawnAtExtended SpawnAt(float radius, float angle, DOMTransformExtended target {{=}} NULL)}}
−
 
+
::
−
:{{CSharp|ReturnType SetScale(Single x, Single y, Single z)}}
+
::Creates a [[DOMPhysicsSpawnAt]] node as a direct child requesting the Spawn operation and given the specified parameters.
−
 
+
−
:{{CSharp|ReturnType SetTransformParent(DOMTransformExtended target, JSVector3 position, JSVector3 rotation, JSVector3 scale)}}
+
  
 
__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.


Retrieved from "http://wiki.virtualworldweb.com/index.php?title=DOMTransformExtended&oldid=6092"