Difference between revisions of "DOMTransformExtended"

Revision as of 00:45, 23 October 2016

Represents a DOMTransform in JavaScript

• Inherits class: DOMObjectExtended
• This is a JavaScript visible object

Remarks [edit]

Properties

string AttachToBone {get; set;} // Via attribution [[DOMTransform]]

The name of a bone in this node's parent's skeleton to which this object should be attached

bool Clickable {get; set;} // Via attribution [[DOMTransform]]

Marks this object as clickable, mainly used node types derived from DOMRenderable or DOMVolume

ResourceValue Cursor {get; set;} // Via attribution [[DOMTransform]]

The ResourceValue for the hover-over mouse cursor to use

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)

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...

bool ExcludeTransform {get; set;} // Via attribution [[DOMTransform]]

When true, this transform's value is excluded when calculating child node transforms

Point3D Position {get; set;} // Via attribution [[DOMTransform]]

Gets or sets the transform's position component

Single RX {get; set;} // Via attribution [[DOMTransform]]

Gets or sets the X part of the transform's rotation component

Single RY {get; set;} // Via attribution [[DOMTransform]]

Gets or sets the Y part of the transform's rotation component

Single RZ {get; set;} // Via attribution [[DOMTransform]]

Gets or sets the Z part of the transform's rotation component

Point3D Rotation {get; set;} // Via attribution [[DOMTransform]]

Gets or sets the transform's rotation component

Point3D RotationAxis {get; set;} // Via attribution [[DOMTransform]]

A normal expressing the direction of rotation

Single RotationSpeed {get; set;} // Via attribution [[DOMTransform]]

The speed by which to multiply the RotationAxis

Single SX {get; set;} // Via attribution [[DOMTransform]]

Gets or sets the X part of the transform's scale component

Single SY {get; set;} // Via attribution [[DOMTransform]]

Gets or sets the Y part of the transform's scale component

Single SZ {get; set;} // Via attribution [[DOMTransform]]

Gets or sets the Z part of the transform's scale component

Point3D Scale {get; set;} // Via attribution [[DOMTransform]]

Gets or sets the transform's scale component

bool Selectable {get; set;} // Via attribution [[DOMTransform]]

Marks this object as Selectable, mainly used node types derived from DOMRenderable or DOMVolume

bool Targetable {get; set;} // Via attribution [[DOMTransform]]

Marks this object as targetable, mainly used node types derived from DOMRenderable or DOMVolume

string Tooltip {get; set;} // Via attribution [[DOMTransform]]

The text for a hover-over tool-tip

ResourceValue TooltipIcon {get; set;} // Via attribution [[DOMTransform]]

The ResourceValue for a hover-over tool-tip's icon

string TooltipTitle {get; set;} // Via attribution [[DOMTransform]]

The text for a hover-over tool-tip's title

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 [[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 [[DOMTransform]]

If this object is moving, this is how fast (in units per second)

Single X {get; set;} // Via attribution [[DOMTransform]]

Gets or sets the X part of the transform's position component

Single Y {get; set;} // Via attribution [[DOMTransform]]

Gets or sets the Y part of the transform's position component

Single Z {get; set;} // Via attribution [[DOMTransform]]

Gets or sets the Z part of the transform's position component

Events

OnClick(EventHandler<FlexibleEventArgs>)

Fires when a user clicks an object in world. Who is the Participant doing the clicking.

OnRightClick(EventHandler<FlexibleEventArgs>)

Fires when a user right-clicks an object in world. Who is the Participant doing the right-clicking.

Methods

bool MoveTo(Single x, Single y, Single z, Single speed, JSFlexibleFunction func)

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.

ReturnType PathTo(Single targetX, Single targetY, Single targetZ, Single speed, JSFlexibleFunction callback)

ReturnType PathToTarget(DOMTransformExtended target, Single speed, JSFlexibleFunction callback)

ReturnType PathToVector(JSVector3 target, Single speed, JSFlexibleFunction callback)

ReturnType PhysicsFollow(DOMTransformExtended target, Single minDistance, Single 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.

ReturnType PhysicsPathTo(Single targetX, Single targetY, Single targetZ, Single speed, JSFlexibleFunction callback)

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.

ReturnType PhysicsPathToTarget(DOMTransformExtended target, Single speed, JSFlexibleFunction callback)

ReturnType PhysicsPathToVector(JSVector3 target, Single speed, JSFlexibleFunction callback)

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.

ReturnType PhysicsProjectile(Single directionX, Single directionY, Single directionZ, Single speed, bool gravity, Single maxDistance)

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.

ReturnType PhysicsProjectileVector(JSVector3 direction, Single speed, bool gravity, Single maxDistance)

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.

ReturnType PhysicsSpawn(Single 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.

ReturnType ResetTransformParent(bool restoreLastPosition)

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(Single x, Single y, Single z, Single speed, JSFlexibleFunction func)

ReturnType RotateToFaceTarget(DOMTransformExtended target, Single speed, JSFlexibleFunction callback)

ReturnType SetPosition(Single x, Single y, Single z)

Sets the position (transform) of this object from its next parent DOMTransform or from world origin (0,0,0).

ReturnType SetRotation(Single x, Single y, Single z)

Sets the rotation of this object relative to its next parent DOMTransform or from (0,0,0)

ReturnType SetScale(Single x, Single y, Single z)

Sets the scale of this object relative to its next parent DOMTransform or from (1,1,1)

ReturnType SetTransformParent(DOMTransformExtended target, JSVector3 position, JSVector3 rotation, JSVector3 scale)

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.