Difference between revisions of "DOMTransform"

From Virtual World Web Wiki
Jump to: navigation, search
(Documentation for the DOMTransform class)
(Documentation for the DOMTransform class)
 
(8 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
* '''Inherits class: [[DOMObject]]'''
+
The base class for all DOM node types that have a transform (position, rotation, scale)
 +
 
 +
*'''Inherits class: [[DOMObject]]'''
 
===Remarks <nowiki>[</nowiki>[{{fullurl:DOMTransform Remarks|action=edit}} edit]<nowiki>]</nowiki>===
 
===Remarks <nowiki>[</nowiki>[{{fullurl:DOMTransform Remarks|action=edit}} edit]<nowiki>]</nowiki>===
−
{{:DOMTransform Remarks}}
+
{{#ifexist:DOMTransform Remarks|{{:DOMTransform Remarks}}|}}
  
 
===Properties===
 
===Properties===
 
:{{CSharp|string AttachToBone {get; set;} }}
 
:{{CSharp|string AttachToBone {get; set;} }}
−
 
+
::
−
:{{CSharp|bool Clickable {get; set;} }}
+
::The name of a bone in this node's parent's skeleton to which this object should be attached
−
 
+
−
:{{CSharp|ResourceValue Cursor {get; set;} }}
+
−
 
+
−
:{{CSharp|Single CursorDistance {get; set;} }}
+
−
 
+
−
:{{CSharp|bool CursorMiddleHotspot {get; set;} }}
+
  
 
:{{CSharp|bool ExcludeTransform {get; set;} }}
 
:{{CSharp|bool ExcludeTransform {get; set;} }}
 +
::
 +
::When true, this transform's value is excluded when calculating child node transforms
 +
 +
:{{CSharp|DOMTransform NextTransform {get;} }}
 +
::
 +
::Finds the next transform up the transform hierarchy
  
 
:{{CSharp|Point3D Position {get; set;} }}
 
:{{CSharp|Point3D Position {get; set;} }}
 +
::
 +
::Gets or sets the transform's position component
  
 
:{{CSharp|Point3D Rotation {get; set;} }}
 
:{{CSharp|Point3D Rotation {get; set;} }}
 +
::
 +
::Gets or sets the transform's rotation component
  
 
:{{CSharp|Point3D RotationAxis {get; set;} }}
 
:{{CSharp|Point3D RotationAxis {get; set;} }}
 +
::
 +
::A normal expressing the direction of rotation
  
−
:{{CSharp|Single RotationSpeed {get; set;} }}
+
:{{CSharp|float RotationSpeed {get; set;} }}
 +
::
 +
::The speed by which to multiply the RotationAxis
  
−
:{{CSharp|Single RX {get; set;} }}
+
:{{CSharp|float RX {get; set;} }}
 +
::
 +
::Gets or sets the X part of the transform's rotation component
  
−
:{{CSharp|Single RY {get; set;} }}
+
:{{CSharp|float RY {get; set;} }}
 +
::
 +
::Gets or sets the Y part of the transform's rotation component
  
−
:{{CSharp|Single RZ {get; set;} }}
+
:{{CSharp|float RZ {get; set;} }}
 +
::
 +
::Gets or sets the Z part of the transform's rotation component
  
 
:{{CSharp|Point3D Scale {get; set;} }}
 
:{{CSharp|Point3D Scale {get; set;} }}
 +
::
 +
::Gets or sets the transform's scale component
  
−
:{{CSharp|bool Selectable {get; set;} }}
+
:{{CSharp|float SX {get; set;} }}
 +
::
 +
::Gets or sets the X part of the transform's scale component
  
−
:{{CSharp|Single SX {get; set;} }}
+
:{{CSharp|float SY {get; set;} }}
 +
::
 +
::Gets or sets the Y part of the transform's scale component
  
−
:{{CSharp|Single SY {get; set;} }}
+
:{{CSharp|float SZ {get; set;} }}
 +
::
 +
::Gets or sets the Z part of the transform's scale component
  
−
:{{CSharp|Single SZ {get; set;} }}
+
:{{CSharp|DOMTransform TransformParent {get; set;} }}
 +
::
 +
::If a TransformParentID has been set, this property contains a reference to this object's transform parent which is used instead of the object's natural position in the DOM hierarchy
  
−
:{{CSharp|bool Targetable {get; set;} }}
+
:{{CSharp|long TransformParentID {get; set;} }}
 +
::
 +
::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|string Tooltip {get; set;} }}
+
:{{CSharp|Point3D Velocity {get; set;} }}
 +
::
 +
::If this object is moving, this is how fast (in units per second)
  
−
:{{CSharp|ResourceValue TooltipIcon {get; set;} }}
+
:{{CSharp|Point3D WorldPosition {get;} }}
  
−
:{{CSharp|string TooltipTitle {get; set;} }}
+
:{{CSharp|float X {get; set;} }}
 +
::
 +
::Gets or sets the X part of the transform's position component
  
−
:{{CSharp|DOMTransform TransformParent {get; set;} }}
+
:{{CSharp|float Y {get; set;} }}
 +
::
 +
::Gets or sets the Y part of the transform's position component
  
−
:{{CSharp|long TransformParentID {get; set;} }}
+
:{{CSharp|float Z {get; set;} }}
 +
::
 +
::Gets or sets the Z part of the transform's position component
  
−
:{{CSharp|Point3D Velocity {get; set;} }}
+
===Constructors===
 +
:{{CSharp|DOMTransform()}}
 +
::
 +
::Constructs a new DOMTransform with default settings
  
−
:{{CSharp|Single X {get; set;} }}
+
:{{CSharp|DOMTransform(DOMObject[] children)}}
 +
::
 +
::Constructs a new DOMTransform, adding children at the same time
  
−
:{{CSharp|Single Y {get; set;} }}
+
:{{CSharp|DOMTransform(string title, DOMObject[] children)}}
−
 
+
::
−
:{{CSharp|Single Z {get; set;} }}
+
::Constructs a new DOMTransform, setting a title and adding children at the same time
  
 
===Methods===
 
===Methods===
 +
:{{CSharp|Matrix4X4 BuildWorldMatrix()}}
 +
 +
:{{CSharp|Point3D BuildWorldPosition()}}
 +
 +
:{{CSharp|double DistanceTo(DOMTransform other)}}
 +
::
 +
::Gets the square distance between two transforms
 +
 
__NOTOC____NOEDITSECTION__
 
__NOTOC____NOEDITSECTION__

Latest revision as of 21:00, 17 July 2018

The base class for all DOM node types that have a transform (position, rotation, scale)

Remarks [edit]

Properties

string AttachToBone {get; set;}
The name of a bone in this node's parent's skeleton to which this object should be attached
bool ExcludeTransform {get; set;}
When true, this transform's value is excluded when calculating child node transforms
DOMTransform NextTransform {get;}
Finds the next transform up the transform hierarchy
Point3D Position {get; set;}
Gets or sets the transform's position component
Point3D Rotation {get; set;}
Gets or sets the transform's rotation component
Point3D RotationAxis {get; set;}
A normal expressing the direction of rotation
float RotationSpeed {get; set;}
The speed by which to multiply the RotationAxis
float RX {get; set;}
Gets or sets the X part of the transform's rotation component
float RY {get; set;}
Gets or sets the Y part of the transform's rotation component
float RZ {get; set;}
Gets or sets the Z part of the transform's rotation component
Point3D Scale {get; set;}
Gets or sets the transform's scale component
float SX {get; set;}
Gets or sets the X part of the transform's scale component
float SY {get; set;}
Gets or sets the Y part of the transform's scale component
float SZ {get; set;}
Gets or sets the Z part of the transform's scale component
DOMTransform TransformParent {get; set;}
If a TransformParentID has been set, this property contains a reference to this object's transform parent which is used instead of the object's natural position in the DOM hierarchy
long TransformParentID {get; set;}
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;}
If this object is moving, this is how fast (in units per second)
Point3D WorldPosition {get;}
float X {get; set;}
Gets or sets the X part of the transform's position component
float Y {get; set;}
Gets or sets the Y part of the transform's position component
float Z {get; set;}
Gets or sets the Z part of the transform's position component

Constructors

DOMTransform()
Constructs a new DOMTransform with default settings
DOMTransform(DOMObject[] children)
Constructs a new DOMTransform, adding children at the same time
DOMTransform(string title, DOMObject[] children)
Constructs a new DOMTransform, setting a title and adding children at the same time

Methods

Matrix4X4 BuildWorldMatrix()
Point3D BuildWorldPosition()
double DistanceTo(DOMTransform other)
Gets the square distance between two transforms


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