Difference between revisions of "DOMTransform"
From Virtual World Web Wiki
(Documentation for the DOMTransform class) |
(Documentation for the DOMTransform class) |
||
Line 1: | Line 1: | ||
+ | The base class for all DOM node type that have a transform (position, rotation, scale) | ||
+ | |||
* '''Inherits class: [[DOMObject]]''' | * '''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>=== | ||
Line 5: | Line 7: | ||
===Properties=== | ===Properties=== | ||
:{{CSharp|string AttachToBone {get; set;} }} | :{{CSharp|string AttachToBone {get; set;} }} | ||
+ | :: | ||
+ | ::The name of a bone in this node's parent's skeleton to which this object should be attached | ||
:{{CSharp|bool Clickable {get; set;} }} | :{{CSharp|bool Clickable {get; set;} }} | ||
+ | :: | ||
+ | ::Marks this object as clickable, mainly used node types derived from [[DOMRenderable]] or [[DOMVolume]] | ||
:{{CSharp|ResourceValue Cursor {get; set;} }} | :{{CSharp|ResourceValue Cursor {get; set;} }} | ||
+ | :: | ||
+ | ::The ResourceValue for the hover-over mouse cursor to use | ||
:{{CSharp|Single CursorDistance {get; set;} }} | :{{CSharp|Single 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) | ||
:{{CSharp|bool CursorMiddleHotspot {get; set;} }} | :{{CSharp|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... | ||
:{{CSharp|bool ExcludeTransform {get; set;} }} | :{{CSharp|bool ExcludeTransform {get; set;} }} | ||
+ | :: | ||
+ | ::When true, this transform's value is excluded when calculating child node transforms | ||
:{{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|Single RotationSpeed {get; set;} }} | ||
+ | :: | ||
+ | ::The speed by which to multiply the RotationAxis | ||
:{{CSharp|Single RX {get; set;} }} | :{{CSharp|Single RX {get; set;} }} | ||
+ | :: | ||
+ | ::Gets or sets the X part of the transform's rotation component | ||
:{{CSharp|Single RY {get; set;} }} | :{{CSharp|Single RY {get; set;} }} | ||
+ | :: | ||
+ | ::Gets or sets the Y part of the transform's rotation component | ||
:{{CSharp|Single RZ {get; set;} }} | :{{CSharp|Single 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|bool Selectable {get; set;} }} | ||
+ | :: | ||
+ | ::Marks this object as Selectable, mainly used node types derived from [[DOMRenderable]] or [[DOMVolume]] | ||
:{{CSharp|Single SX {get; set;} }} | :{{CSharp|Single SX {get; set;} }} | ||
+ | :: | ||
+ | ::Gets or sets the X part of the transform's scale component | ||
:{{CSharp|Single SY {get; set;} }} | :{{CSharp|Single SY {get; set;} }} | ||
+ | :: | ||
+ | ::Gets or sets the Y part of the transform's scale component | ||
:{{CSharp|Single SZ {get; set;} }} | :{{CSharp|Single SZ {get; set;} }} | ||
+ | :: | ||
+ | ::Gets or sets the Z part of the transform's scale component | ||
:{{CSharp|bool Targetable {get; set;} }} | :{{CSharp|bool Targetable {get; set;} }} | ||
+ | :: | ||
+ | ::Marks this object as targetable, mainly used node types derived from [[DOMRenderable]] or [[DOMVolume]] | ||
:{{CSharp|string Tooltip {get; set;} }} | :{{CSharp|string Tooltip {get; set;} }} | ||
+ | :: | ||
+ | ::The text for a hover-over tool-tip | ||
:{{CSharp|ResourceValue TooltipIcon {get; set;} }} | :{{CSharp|ResourceValue TooltipIcon {get; set;} }} | ||
+ | :: | ||
+ | ::The ResourceValue for a hover-over tool-tip's icon | ||
:{{CSharp|string TooltipTitle {get; set;} }} | :{{CSharp|string TooltipTitle {get; set;} }} | ||
+ | :: | ||
+ | ::The text for a hover-over tool-tip's title | ||
:{{CSharp|DOMTransform TransformParent {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|long TransformParentID {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|Point3D Velocity {get; set;} }} | :{{CSharp|Point3D Velocity {get; set;} }} | ||
+ | :: | ||
+ | ::If this object is moving, this is how fast (in units per second) | ||
:{{CSharp|Single X {get; set;} }} | :{{CSharp|Single X {get; set;} }} | ||
+ | :: | ||
+ | ::Gets or sets the X part of the transform's position component | ||
:{{CSharp|Single Y {get; set;} }} | :{{CSharp|Single Y {get; set;} }} | ||
+ | :: | ||
+ | ::Gets or sets the Y part of the transform's position component | ||
:{{CSharp|Single Z {get; set;} }} | :{{CSharp|Single Z {get; set;} }} | ||
+ | :: | ||
+ | ::Gets or sets the Z part of the transform's position component | ||
===Constructors=== | ===Constructors=== | ||
:{{CSharp|DOMTransform()}} | :{{CSharp|DOMTransform()}} | ||
+ | :: | ||
+ | ::Constructs a new DOMTransform with default settings | ||
:{{CSharp|DOMTransform(DOMObject[] children)}} | :{{CSharp|DOMTransform(DOMObject[] children)}} | ||
+ | :: | ||
+ | ::Constructs a new DOMTransform, adding children at the same time | ||
:{{CSharp|DOMTransform(string title, DOMObject[] children)}} | :{{CSharp|DOMTransform(string title, DOMObject[] children)}} | ||
+ | :: | ||
+ | ::Constructs a new DOMTransform, setting a title and adding children at the same time | ||
__NOTOC____NOEDITSECTION__ | __NOTOC____NOEDITSECTION__ |
Revision as of 20:07, 16 October 2016
The base class for all DOM node type that have a transform (position, rotation, scale)
- Inherits class: DOMObject
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
- Single 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
- Single RotationSpeed {get; set;}
- The speed by which to multiply the RotationAxis
- Single RX {get; set;}
- Gets or sets the X part of the transform's rotation component
- Single RY {get; set;}
- Gets or sets the Y part of the transform's rotation component
- Single 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
- Single SX {get; set;}
- Gets or sets the X part of the transform's scale component
- Single SY {get; set;}
- Gets or sets the Y part of the transform's scale component
- Single 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)
- Single X {get; set;}
- Gets or sets the X part of the transform's position component
- Single Y {get; set;}
- Gets or sets the Y part of the transform's position component
- Single 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