Difference between revisions of "DOMTransform"

From Virtual World Web Wiki
Jump to: navigation, search
(Documentation for the DOMTransform class)
(Documentation for the DOMTransform class)
Line 18: Line 18:
 
::The ResourceValue for the hover-over mouse cursor to use
 
::The ResourceValue for the hover-over mouse cursor to use
  
:{{CSharp|Single CursorDistance {get; set;} }}
+
:{{CSharp|float CursorDistance {get; set;} }}
 
::
 
::
 
::The distance in units before which the object can be hovered over with the mouse causing cursor change and/or tooltip activation (if configured)
 
::The distance in units before which the object can be hovered over with the mouse causing cursor change and/or tooltip activation (if configured)
Line 42: Line 42:
 
::A normal expressing the direction of rotation
 
::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
 
::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
 
::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
 
::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
 
::Gets or sets the Z part of the transform's rotation component
Line 66: Line 66:
 
::Marks this object as Selectable, mainly used node types derived from [[DOMRenderable]] or [[DOMVolume]]
 
::Marks this object as Selectable, mainly used node types derived from [[DOMRenderable]] or [[DOMVolume]]
  
:{{CSharp|Single SX {get; set;} }}
+
:{{CSharp|float SX {get; set;} }}
 
::
 
::
 
::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;} }}
+
:{{CSharp|float SY {get; set;} }}
 
::
 
::
 
::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;} }}
+
:{{CSharp|float SZ {get; set;} }}
 
::
 
::
 
::Gets or sets the Z part of the transform's scale component
 
::Gets or sets the Z part of the transform's scale component
Line 106: Line 106:
 
::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;} }}
+
:{{CSharp|float X {get; set;} }}
 
::
 
::
 
::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;} }}
+
:{{CSharp|float Y {get; set;} }}
 
::
 
::
 
::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;} }}
+
:{{CSharp|float Z {get; set;} }}
 
::
 
::
 
::Gets or sets the Z part of the transform's position component
 
::Gets or sets the Z part of the transform's position component

Revision as of 17:55, 20 February 2017

The base class for all DOM node type 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 Clickable {get; set;}
Marks this object as clickable, mainly used node types derived from DOMRenderable or DOMVolume
ResourceValue Cursor {get; set;}
The ResourceValue for the hover-over mouse cursor to use
float CursorDistance {get; set;}
The distance in units before which the object can be hovered over with the mouse causing cursor change and/or tooltip activation (if configured)
bool CursorMiddleHotspot {get; set;}
True if the center of the cursor image should be used as the hotspot... oh dear why is this not an Point2D offset...
bool ExcludeTransform {get; set;}
When true, this transform's value is excluded when calculating child node transforms
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
bool Selectable {get; set;}
Marks this object as Selectable, mainly used node types derived from DOMRenderable or DOMVolume
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
bool Targetable {get; set;}
Marks this object as targetable, mainly used node types derived from DOMRenderable or DOMVolume
string Tooltip {get; set;}
The text for a hover-over tool-tip
ResourceValue TooltipIcon {get; set;}
The ResourceValue for a hover-over tool-tip's icon
string TooltipTitle {get; set;}
The text for a hover-over tool-tip's title
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)
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