Visual3D Game EngineAPI Documentation for XNA, C#, VB, and .NET

Namespace: Visual3D
Assembly: Visual3D.Engine (in Visual3D.Engine.dll) Version: 1.0.0.0 (1.0.0.0)

Syntax

      
 C#  Visual Basic 
public sealed class SpatialNode : ISpatialObject, 
	IHandleProvider, INamed, IDisposed, IDisposable
Public NotInheritable Class SpatialNode _
	Implements ISpatialObject, IHandleProvider, INamed, IDisposed,  _
	IDisposable

Members

                  
 All Members  Constructors   Fields   Properties   Methods   Events  
 Public

 Protected
 Instance

 Static 
 Declared

 Inherited
 XNA Framework Only 

 .NET Compact Framework Only 

 MemberDescription
SpatialNode(SceneObject, Single)
Initializes a new instance of the SpatialNode class
AddChild(SceneObject)
AddChild(SceneObject, Vector3)
AddChild(SceneObject, Boolean)
Adds a node to the list of children of this node.
AddChild(SceneObject, ObjectUsage)
AddChild(SceneObject, PartSelectability)
AddChild(SceneObject, Vector3, Boolean)
AddChild(SceneObject, Vector3, Rotation)
Adds an Entity as a child of this node, at the specified location.
AddChild(SceneObject, Single, Single)
AddChild(SceneObject, Vector3, Boolean, Rotation)
AddChild(SceneObject, Vector3, Angle, Angle, Angle)
Adds an Entity as a child of this node, at the specified location and rotation.
AddChildren(IEnumerable<(Of <<'(SceneObject>)>>))
AddChildren(array<SceneObject>[]()[][])
AddPart(SceneObject)
Adds an object to become a "part" of this parent object.
AddPart(SceneObject, Boolean)
Adds an object to become a "part" of this parent object.
AddParts(IEnumerable<(Of <<'(SceneObject>)>>))
Adds an object to become a "part" of this parent object.
AddParts(array<SceneObject>[]()[][])
Adds an object to become a "part" of this parent object.
AdjustScale(Vector3)
ApplyScaleFromAnimations
ApplyWeightedTransform(Single, Vector3, Quaternion, Vector3)
This method transforms a Bone by a weighted amount from it's initial state. If weighted transforms have already been applied, the previous transforms and this one are blended together based on their relative weight. This method should not be used in combination with the unweighted rotate, translate etc methods.
AreEventsAlwaysEnabled
AreMoveEventsEnabled
BoundingRadius
Largest distance from the center of any point on the Entity/Model.
BoundingRadiusMinimum
BoundingRadiusSquared
CalculateSizeFromScaling()()()()
CameraFocusHeightRatio
CameraFocusOffset
CaptureInitialState()()()()
Sets the current transform of this node to be the 'initial state' ie that position / orientation / scale to be used as a basis for delta values used in keyframe animation.
Children
ChildrenCount
ChildrenList
Clone(SceneObject)
Creates a shallow copy of SpatialNode
DefaultAltitudeAttenuation
DefaultCameraFocusHeightRatio
DefaultChildrenListSize
Depth
Gets the Z (forward) dimension of the object's Size.
DesignMode
Direction
Dispose()()()()
DistanceFromGround
DWorldPosition
Gets/sets the world position in double-precision value format.
EnsureBoundingBoxUpdated()()()()
EnsureUpdated()()()()
Calls Update() only if local spatial data is dirty.
FindMaxViewDistanceSquared
ForceDisableViewDistanceCulling()()()()
ForceUpdate()()()()
Calls Update() only if local spatial data is dirty.
ForEachChildNode(Action<(Of <<'(SpatialNode>)>>), Boolean)
ForEachChildNodeIf(Predicate<(Of <<'(SpatialNode>)>>), Boolean)
ForEachChildObject<(Of <<'(T>)>>)(Action<(Of <<'(T>)>>), Boolean)
Enumerate list of children scene objects with given callback method called per-object for all scene object matching type T.
ForEachChildObject(Action<(Of <<'(SceneObject>)>>), Boolean)
Enumerate list of children scene objects with given callback method called per-object.
ForEachChildObjectIf<(Of <<'(T>)>>)(Predicate<(Of <<'(T>)>>), Boolean)
Enumerate list of children scene objects with given callback method called per-object for all scene object matching type T.
ForEachChildObjectIf(Predicate<(Of <<'(SceneObject>)>>), Boolean)
GetChild<(Of <<'(TChild>)>>)()()()()
GetChild(Int32)
Gets a child node by index.
GetChild<(Of <<'(TChild>)>>)(Predicate<(Of <<'(TChild>)>>))
GetChild(String)
Gets a child by Name.
GetChild<(Of <<'(TChild>)>>)(TChild%)
GetChild(Predicate<(Of <<'(SceneObject>)>>))
GetChild<(Of <<'(TChild>)>>)(Predicate<(Of <<'(TChild>)>>), Boolean)
GetChild(String, Boolean)
GetChild(Predicate<(Of <<'(SceneObject>)>>), Boolean)
GetChildEntities<(Of <<'(TChildObject>)>>)()()()()
GetChildEntities()()()()
GetChildEntities(Boolean)
GetChildEntities<(Of <<'(TChildObject>)>>)(Predicate<(Of <<'(TChildObject>)>>))
GetChildEntities(Predicate<(Of <<'(SceneEntity>)>>))
GetChildEntities<(Of <<'(TChildObject>)>>)(Predicate<(Of <<'(TChildObject>)>>), Boolean)
GetChildEntities(Predicate<(Of <<'(SceneEntity>)>>), Boolean)
GetChildEntities<(Of <<'(TChildObject>)>>)(Predicate<(Of <<'(TChildObject>)>>), Boolean, Boolean)
GetChildNode(Predicate<(Of <<'(SpatialNode>)>>))
GetChildNode(String, Boolean)
GetChildNode(Predicate<(Of <<'(SpatialNode>)>>), Boolean)
GetChildNodes()()()()
GetChildNodes(Predicate<(Of <<'(SpatialNode>)>>))
GetChildNodes(Predicate<(Of <<'(SpatialNode>)>>), Boolean)
GetChildObjects<(Of <<'(TChildObject>)>>)()()()()
GetChildObjects()()()()
GetChildObjects(Boolean)
GetChildObjects<(Of <<'(TChildObject>)>>)(Predicate<(Of <<'(TChildObject>)>>))
GetChildObjects(Predicate<(Of <<'(SceneObject>)>>))
GetChildObjects<(Of <<'(TChildObject>)>>)(Predicate<(Of <<'(TChildObject>)>>), Boolean)
GetChildObjects(Predicate<(Of <<'(SceneObject>)>>), Boolean)
GetChildObjects<(Of <<'(TChildObject>)>>)(Predicate<(Of <<'(TChildObject>)>>), Boolean, Boolean)
GetDisplacementTo(Vector3)
GetDisplacementTo(SceneObject)
GetDisplacementTo(SpatialNode)
GetDistanceAboveGround()()()()
GetDistanceAboveGround(HeightQueryObjectType)
GetDistanceToSquared(Vector3)
GetDistanceToSquared(SpatialNode)
GetDistanceToSquared(Vector3, Single)
Returns the Distance Squared between this spatial node and the specified Position (and subtracts the bounding radius). altitudeAttenuation: set to less than 1 to lessen the influence of altitude; zero would mean altitude has no influence.
GetDistanceToSquared(SpatialNode, Single)
Returns the Distance Squared between this spatial node and the specified Position (and subtracts the bounding radius).
GetLocalBoundingBoxCenter()()()()
GetLocalBoundingBoxSize()()()()
GetOffsetInDirection(Vector3)
GetOffsetInDirection(Boolean, Boolean, Vector3)
GetRotationTo(SceneObject)
GetRotationTo(SpatialNode)
GetSize(Boolean, Boolean)
GetSize(Boolean, Boolean, Vector3%)
GetViewPoint()()()()
GetViewPoint(Vector3)
GetViewPoint(Scalar, Boolean, Vector3)
Gets the world position or offset from world position (including world scaling) which should be used as the position that an entity or camera would view from (if this object is the viewer) or would look at (for example, the head of an NPC) if this is a viewing target being looked at.
GetWorldOrientation(Boolean)
Returns world orientation, optionally skips update of spatial data. This allows to method which are performing in other threads to not harm on spatial data.
GetWorldPosition(Vector3%, Boolean)
Returns world position, optionally skips update of spatial data. This allows to method which are performing in other threads to not harm on spatial data.
GetWorldScale(Vector3%, Boolean)
Returns world scale, optionally skips update of spatial data. This allows to method which are performing in other threads to not harm on spatial data.
GetWorldTransform(Matrix%, Boolean)
Returns world matrix, optionally skips update of spatial data. This allows to method which are performing in other threads to not harm on spatial data.
HasChild(String)
HasChild(SceneObject)
HasChildren
HasIndependentChildren
HasMaxViewDistance
HasNestedChild(SceneObject)
Recurses down the Child-Trees to find this Object.
HasParent
HasParts
HasScene
Reference to the scene manager who created this object.
Height
Y-Component of the Size, which is the standard axis for "Height" in Visual3D.
IgnoresOrientation
Indicates if object does not really have an 'Orientation' in the scene.
IgnoresPosition
Indicates if object does not really have a 'Position' in the scene.
IgnoresSpatialState
Indicates if object does not really have a 'spatial state' in the scene (i.e. no real position or orientation).
InheritParentOrientation
Tells the scene object whether it should inherit orientation from it's parent scene object.
InheritParentPosition
Tells the scene object whether it should inherit positional offset from it's parent scene object.
InheritParentScale
Tells the scene object whether it should inherit scaling factors from it's parent scene object.
Intersects(Vector3)
Intersects(Vector3%)
Intersects(SceneObject)
Intersects(SpatialNode)
Intersects(BoundingBox%, Boolean)
Intersects(Vector3, Boolean)
Intersects(Vector3%, Boolean)
Intersects(SceneObject, Boolean)
Intersects(SpatialNode, Boolean)
Invalidate()()()()
IsBoundingBoxMergedWithParent
IsDescendentOf(SceneObject, Boolean)
IsDescendentOf(SpatialNode, Boolean)
IsDisposed
IsGrounded
IsInMainScene
IsInRange(SpatialNode)
IsInRange(SpatialNode, Single)
IsInRange(SpatialNode, Single, Boolean)
IsInRangeSquared(SceneObject, Single)
IsNullOrDisposed(IDisposed) (Inherited from XnaMethodExtensions.)
IsPartOfParent
IsYawAxisFixed
LocalAxes
Gets matrix whose columns are the local axes based on orientation relative to the parent.
LocalBoundingBox
Gets/sets local-space unscaled bounds of this scene node.
LookAt(Vector3)
Aims SceneObject current orientation "at" the specified target location.
LookAt(Vector3%)
LookAt(SceneObject)
LookAt(Vector3, Vector3)
Aims SceneObject current orientation "at" the specified target location.
LookAt(Single, Single)
Level - Aims SceneObject current orientation "at" the specified target location - LEVEL (don't do "pitch").
LookAt(Single, Single, Vector3)
Level - Aims SceneObject current orientation "at" the specified target location - LEVEL (don't do "pitch").
MaxViewDistance
MaxViewDistanceSquared
MaxViewDistanceToDiameterRatio
MinBoxSizeForMaxViewDistanceCalculation
MinimumScale
Motion
Move(Vector3)
Moves the node along the cartesian axes. This method moves the node by the supplied vector along the world cartesian axes, i.e. along world x,y,z
Move(Vector3, Boolean)
Moves the node along the cartesian axes. This method moves the node by the supplied vector along the world cartesian axes, i.e. along world x,y,z
Move(Vector3, TransformSpace, Boolean)
Moves the node along the cartesian axes. This method moves the node by the supplied vector along the world cartesian axes, i.e. along world x,y,z
Move(Single, Single, Single)
Move(VMatrix3, Vector3, Boolean)
Moves the node along arbitrary axes.
Move(VMatrix3, Vector3, TransformSpace, Boolean)
Moves the node along arbitrary axes.
Moved
Event triggers whenever this Object's Position changes.
MoveToDefaultDistanceFromGround()()()()
MoveToRelative(Vector3)
Set Position and Orientation for node relative to parent node.
Name
ObjectID
OnBoundingBoxInvalid()()()()
OnMoved()()()()
OnMoved(Boolean)
OnRotated()()()()
OnRotated(Boolean)
ParentChanged
ParentNode
ParentSceneObject
Parent SceneObject of which this SceneObject is listed as a child.
PartOwner
PhysicsBody
PhysicsSettings
Positioning
RelativeOrientation
Orientation relative to Parent node.
RelativePosition
The position of the node relative to its parent.
RelativeScale
The scaling factor applied to this node.
RelativeScaleUniform
RelativeToOurNearestPoint
RemoveChild(Int32)
RemoveChild(String)
Removes the child node with the specified name.
RemoveChild(SceneObject)
Removes the specifed node as a child of this node.
RemoveChildren()()()()
Removes all child nodes from this node.
RemoveChildren<(Of <<'(T>)>>)()()()()
Removes child nodes of specified/derived type from this node.
RemoveChildren(Predicate<(Of <<'(SceneObject>)>>))
Removes child nodes selected by predicate (or all if predicate is null) from this node.
RemoveFromParent()()()()
ResetToInitialState()()()()
ResetToInitialState(Boolean)
Resets the position / orientation / scale of this node to it's initial state, see SetInitialState for more info.
Resized
Event triggers whenever this Object's Size changes.
RootNode
RootObject
Rotate(Quaternion)
Rotates node along specified axis, in WorldSpace.
Rotate(Rotation)
Rotates node along specified axis, relative to parent.
Rotate(Rotation, Boolean)
Rotates node along specified axis, relative to parent.
Rotate(Quaternion, TransformSpace, Boolean)
Rotate the node around an arbitrary axis using a Test_Quaternion.
Rotate(Rotation, Boolean, TransformSpace)
Rotates node along specified axis.
Rotate(Vector3, Single, TransformSpace, Boolean)
Rotate the node around an arbitrary axis.
RotateAndScaleAboutPivotPoint(Vector3, Rotation, Vector3)
Rotated
Event triggers whenever this Object's Orientation changes.
RotateDegrees(Vector3, Single, Boolean)
Rotate object around an arbitrary axis.
RotateDegrees(Vector3, Single, TransformSpace, Boolean)
Rotate the node around an arbitrary axis.
RotatePitch(Single, Boolean)
Rotates node in relative Pitch direction (i.e. tilt 'up' or 'down').
RotatePitch(Single, TransformSpace, Boolean)
Rotates node in relative Pitch direction (i.e. tilt 'up' or 'down').
RotatePitchDegrees(Single, Boolean)
Rotates node in relative Pitch direction (i.e. tilt 'up' or 'down').
RotatePitchDegrees(Single, TransformSpace, Boolean)
Rotates node in relative Pitch direction (i.e. tilt 'up' or 'down').
RotateRoll(Single, Boolean)
Rocks object side-to-side (like a plane rolls into a sharp turn).
RotateRoll(Single, TransformSpace, Boolean)
Rocks object side-to-side (like a plane rolls into a sharp turn).
RotateRollDegrees(Single, Boolean)
Rocks object side-to-side (like a plane rolls into a sharp turn).
RotateRollDegrees(Single, TransformSpace, Boolean)
Rocks object side-to-side (like a plane rolls into a sharp turn).
RotateTo(Quaternion, Boolean)
RotateYaw(Single, Boolean)
Spins object on the upright axis (like a person turning around).
RotateYawDegrees(Single, Boolean)
Spins object on the upright axis (like a person turning around).
RotateYawDegrees(Single, TransformSpace, Boolean)
Spins object on the upright axis (like a person turning around).
Scene
Gets or sets the actual scene this object belongs in. Unlike the SceneOrDefault property, this can be null and won't return World.Scene when it is null.
SceneID
Gets or sets the Scene the object belongs to. When null, the current main scene (World.Scene) will be returned, or else NullScene instance if there is no current scene, to ensure that this will never be a null reference.
SceneObject
SceneObject associated with this Spatial Node
SceneOrDefault
Gets or sets the scene this object belongs in, or returns the default scene. If this is not assigned to any scene, a the current main scene (or else a default empty scene) will be returned, to ensure null is never returned.
SetDirection(Vector3, Vector3)
SetDirection(Vector3%, Vector3%)
Sets the node's direction vector.
SetHeight(Single)
Sets the World Height of this object.
SetLocalBoundingBox(BoundingBox)
SetLocalBoundingBox(BoundingBox, Boolean)
SetLocalBoundingBox(Vector3, Vector3)
SetMaxDimensionLength(Single)
Set's size of the longest world-space dimension of this object based on the LocalBoundingBox. All the reset of the dimensions are then scaled proportionately.
SetUniformScale(Single)
Scales the node, combining it's current scale with the passed in scaling factor.
SetWorldBoundingBox(BoundingBox)
SetWorldBoundingBox(Vector3, Vector3)
Size
Set's size of the Local-scaled Bounding box to be this value, in all 3 dimensions. The units are assumed to be default World Application units, for current Application.
StartingState
SynchronizeWorldOrientation(Quaternion)
SynchronizeWorldPosition(Vector3)
ToString()()()() (Overrides Object..::..ToString()()()().)
UnscaledAltitudeAttenuation
Update(Boolean)
Internal method to update the Node.
Updated
Fires after spatial data of scene object has been updated.
Width
Gets the X (side-to-side) dimension of the object's Size.
WorldBoundingBox
Gets the axis-aligned bounding box of this node (and hence all child nodes).
WorldBoundingBoxBottom
Gets the Min.Y value of the WorldBoundingBox.
WorldBoundingBoxHalfExtents
WorldBoundingBoxHeight
Height (Y-dimension) of the WorldBoundingBox.
WorldBoundingBoxSize
WorldBoundingBoxTop
Gets the Max.Y value of the WorldBoundingBox.
WorldCenter
Position of Center of BoundingBox relative to World Origin.
WorldOrientation
Orientation relative to World Axis.
WorldPosition
Position relative to World Origin.
WorldRotation
World Orientation expressed as Yaw, Pitch, and Roll.
WorldScale
Gets the scaling factor of the node as derived from all parents.
WorldScaleUniform
WorldTransform
Gets the full transformation matrix for this scene object.

Inheritance Hierarchy

System..::..Object
  Visual3D..::..SpatialNode

See Also