/Dlls/Delta.Rendering.SceneGraph.xml

<?xml version="1.0"?>

<doc>

    <assembly>

        <name>Delta.Rendering.SceneGraph</name>

    </assembly>

    <members>

        <member name="T:Delta.Rendering.SceneGraph.SceneGraphNodeGeometry">

            <summary>

            SceneGraphNode for Geometry and Material based data.

            </summary>

        </member>

        <member name="T:Delta.Rendering.SceneGraph.SceneGraphNode">

            <summary>

            Represents Node that can be part of global Scene hierarchy.

            Note that every SceneNode can have more than one children.

            </summary>

        </member>

        <member name="F:Delta.Rendering.SceneGraph.SceneGraphNode.lockObject">

            <summary>

            Sync object to be locked during RenderAll

            </summary>

        </member>

        <member name="F:Delta.Rendering.SceneGraph.SceneGraphNode.worldTransformation">

            <summary>

            Matrix combined with Parent local transformation.

            </summary>

        </member>

        <member name="F:Delta.Rendering.SceneGraph.SceneGraphNode.localPosition">

            <summary>

            Local position of this node.

            </summary>

        </member>

        <member name="F:Delta.Rendering.SceneGraph.SceneGraphNode.localRotation">

            <summary>

            Local rotation of this node.

            </summary>

        </member>

        <member name="F:Delta.Rendering.SceneGraph.SceneGraphNode.localScale">

            <summary>

            Local scale of this node.

            </summary>

        </member>

        <member name="F:Delta.Rendering.SceneGraph.SceneGraphNode.localTransformation">

            <summary>

            Local transformation of this node.

            </summary>

        </member>

        <member name="F:Delta.Rendering.SceneGraph.SceneGraphNode.recalculate">

            <summary>

            Value that indicates whether to calculate the full transformation.

            </summary>

        </member>

        <member name="F:Delta.Rendering.SceneGraph.SceneGraphNode.children">

            <summary>

            List containing all children of this node.

            </summary>

        </member>

        <member name="M:Delta.Rendering.SceneGraph.SceneGraphNode.#ctor">

            <summary>

            Creates a new instance of <see cref="T:Delta.Rendering.SceneGraph.SceneGraphNode"/>

            </summary>

        </member>

        <member name="M:Delta.Rendering.SceneGraph.SceneGraphNode.ResetLocal">

            <summary>

            Resets the node to original values.

            </summary>

        </member>

        <member name="M:Delta.Rendering.SceneGraph.SceneGraphNode.Add(Delta.Rendering.SceneGraph.SceneGraphNode)">

            <summary>

            Add a new node to the end of the child node list.

            </summary>

            <param name="toAdd">Node to add.</param>

        </member>

        <member name="M:Delta.Rendering.SceneGraph.SceneGraphNode.Add(System.Collections.Generic.IEnumerable{Delta.Rendering.SceneGraph.SceneGraphNode})">

            <summary>

            Adds an enumerable list of SceneGraphNode to this node.

            </summary>

            <param name="toAdd">Nodes to add.</param>

        </member>

        <member name="M:Delta.Rendering.SceneGraph.SceneGraphNode.Insert(System.Int32,Delta.Rendering.SceneGraph.SceneGraphNode)">

            <summary>

            Inserts node at specific position.

            </summary>

            <param name="index">Index where to insert.</param>

            <param name="toAdd">Node to add.</param>

        </member>

        <member name="M:Delta.Rendering.SceneGraph.SceneGraphNode.Insert(System.Int32,System.Collections.Generic.IEnumerable{Delta.Rendering.SceneGraph.SceneGraphNode})">

            <summary>

            Inserts enumerable list of nodes at specific location.

            </summary>

            <param name="index">Index where to insert.</param>

            <param name="toAdd">Nodes to add.</param>

        </member>

        <member name="M:Delta.Rendering.SceneGraph.SceneGraphNode.Remove(Delta.Rendering.SceneGraph.SceneGraphNode)">

            <summary>

            Removes child node.

            </summary>

            <param name="toRemove">Node to remove.</param>

            <returns>True if remove succeeded.</returns>

        </member>

        <member name="M:Delta.Rendering.SceneGraph.SceneGraphNode.RemoveAt(System.Int32)">

            <summary>

            Removes child node at index.

            </summary>

            <param name="index">Index where to remove.</param>

        </member>

        <member name="M:Delta.Rendering.SceneGraph.SceneGraphNode.RemoveFromParent">

            <summary>

            Removes this node from parent.

            </summary>

        </member>

        <member name="M:Delta.Rendering.SceneGraph.SceneGraphNode.Clear">

            <summary>

            Removes all child nodes.

            </summary>

        </member>

        <member name="M:Delta.Rendering.SceneGraph.SceneGraphNode.GetLocalPosition(Delta.Utilities.Datatypes.Vector@)">

            <summary>

            Method to get the local position.

            </summary>

            <param name="whereToSet">Where to store the position.</param>

        </member>

        <member name="M:Delta.Rendering.SceneGraph.SceneGraphNode.SetLocalPosition(Delta.Utilities.Datatypes.Vector@)">

            <summary>

            Set the local position.

            </summary>

            <param name="toSet">What to set.</param>

        </member>

        <member name="M:Delta.Rendering.SceneGraph.SceneGraphNode.SetLocalPosition(System.Single,System.Single,System.Single)">

            <summary>

            Set local position.

            </summary>

            <param name="x">X coordinate.</param>

            <param name="y">Y coordinate.</param>

            <param name="z">Z coordinate.</param>

        </member>

        <member name="M:Delta.Rendering.SceneGraph.SceneGraphNode.OffsetLocalPosition(Delta.Utilities.Datatypes.Vector@)">

            <summary>

            Offset the local position with given value.

            </summary>

            <param name="toSet">What to offset.</param>

            <param name="toOffset">Offset</param>

        </member>

        <member name="M:Delta.Rendering.SceneGraph.SceneGraphNode.OffsetLocalPosition(System.Single,System.Single,System.Single)">

            <summary>

            Method to offset local position.

            </summary>

            <param name="x">X coordinate.</param>

            <param name="y">Y coordinate.</param>

            <param name="z">Z coordinate.</param>

        </member>

        <member name="M:Delta.Rendering.SceneGraph.SceneGraphNode.GetLocalRotation(Delta.Utilities.Datatypes.Vector@)">

            <summary>

            Method to get the local rotation.

            </summary>

            <param name="whereToSet">Where to store the rotation.</param>

        </member>

        <member name="M:Delta.Rendering.SceneGraph.SceneGraphNode.SetLocalRotation(Delta.Utilities.Datatypes.Vector@)">

            <summary>

            Method to set the local rotation.

            </summary>

            <param name="toSet">What to set.</param>

        </member>

        <member name="M:Delta.Rendering.SceneGraph.SceneGraphNode.SetLocalRotation(System.Single,System.Single,System.Single)">

            <summary>

            Method to set local rotation.

            </summary>

            <param name="x">X coordinate.</param>

            <param name="y">Y coordinate.</param>

            <param name="z">Z coordinate.</param>

        </member>

        <member name="M:Delta.Rendering.SceneGraph.SceneGraphNode.GetLocalScale(Delta.Utilities.Datatypes.Vector@)">

            <summary>

            Method to get the local scale.

            </summary>

            <param name="whereToSet">Where to store the scale.</param>

        </member>

        <member name="M:Delta.Rendering.SceneGraph.SceneGraphNode.SetLocalScale(Delta.Utilities.Datatypes.Vector@)">

            <summary>

            Method for setting the local scale.

            </summary>

            <param name="toSet">What to set.</param>

        </member>

        <member name="M:Delta.Rendering.SceneGraph.SceneGraphNode.SetLocalScale(System.Single,System.Single,System.Single)">

            <summary>

            Method for setting local scale.

            </summary>

            <param name="x">X coordinate.</param>

            <param name="y">Y coordinate.</param>

            <param name="z">Z coordinate.</param>

        </member>

        <member name="M:Delta.Rendering.SceneGraph.SceneGraphNode.GetLocalTransformation(Delta.Utilities.Datatypes.Matrix@)">

            <summary>

            Method to get the local transformation matrix.

            </summary>

            <param name="whereToGet">Where the local matrix is stored.</param>

        </member>

        <member name="M:Delta.Rendering.SceneGraph.SceneGraphNode.GetWorldTransformation(Delta.Utilities.Datatypes.Matrix@)">

            <summary>

            Method to get the world transformation matrix.

            </summary>

            <param name="whereToGet">Where the world matrix is stored.</param>

        </member>

        <member name="M:Delta.Rendering.SceneGraph.SceneGraphNode.GetWorldPosition(Delta.Utilities.Datatypes.Vector@)">

            <summary>

            Method to get the world position of the node.

            </summary>

            <param name="whereToSet">Where to store the position.</param>

        </member>

        <member name="M:Delta.Rendering.SceneGraph.SceneGraphNode.GetWorldRotation(Delta.Utilities.Datatypes.Vector@)">

            <summary>

            Method to getting the world rotation.

            </summary>

            <param name="whereToSet">Where to store the rotation.</param>

        </member>

        <member name="M:Delta.Rendering.SceneGraph.SceneGraphNode.GetWorldScale(Delta.Utilities.Datatypes.Vector@)">

             <summary>

            Get the world scale.

             </summary>

             <param name="whereToSet">Where to store the scale.</param>

        </member>

        <member name="M:Delta.Rendering.SceneGraph.SceneGraphNode.Render">

            <summary>

            Render method to be called when this node is to be rendered. 

            Override if you need to render this node.

            </summary>

        </member>

        <member name="M:Delta.Rendering.SceneGraph.SceneGraphNode.RenderAll">

            <summary>

            Renders all child nodes and this node.

            </summary>

        </member>

        <member name="M:Delta.Rendering.SceneGraph.SceneGraphNode.UpdateTransformation">

            <summary>

            Updates local and world transformation if needed, so if Recalculate is 

            true then it is recalculated.

            </summary>

            <returns>

            True if the matrices were recalculated.

            </returns>

        </member>

        <member name="M:Delta.Rendering.SceneGraph.SceneGraphNode.CheckDepth(Delta.Rendering.SceneGraph.SceneGraphNode)">

            <summary>

            Checks the node depth.

            </summary>

            <param name="toCheck">Graph node to check.</param>

        </member>

        <member name="P:Delta.Rendering.SceneGraph.SceneGraphNode.RenderOrder">

            <summary>

            This property sets the child node render order. If ChildrenFirst then

            child nodes are processed first and then the current node, ChildrenLast

            is the opposite.

            </summary>

        </member>

        <member name="P:Delta.Rendering.SceneGraph.SceneGraphNode.Parent">

            <summary>

            Gets the parent of this node.

            </summary>

        </member>

        <member name="P:Delta.Rendering.SceneGraph.SceneGraphNode.Root">

            <summary>

            Property to get the root node.

            </summary>

        </member>

        <member name="P:Delta.Rendering.SceneGraph.SceneGraphNode.Depth">

            <summary>

            Gets the depth of the tree beginning from this node.

            </summary>

        </member>

        <member name="P:Delta.Rendering.SceneGraph.SceneGraphNode.ChildrenCount">

            <summary>

            Gets the children count.

            </summary>

        </member>

        <member name="P:Delta.Rendering.SceneGraph.SceneGraphNode.Children">

            <summary>

            Gets enumerator of all children of this node.

            </summary>

        </member>

        <member name="P:Delta.Rendering.SceneGraph.SceneGraphNode.LocalPosition">

            <summary>

            Gets or Sets the local position. 

            Use method <see cref="M:Delta.Rendering.SceneGraph.SceneGraphNode.GetLocalPosition(Delta.Utilities.Datatypes.Vector@)"/> for performance.

            </summary>

        </member>

        <member name="P:Delta.Rendering.SceneGraph.SceneGraphNode.LocalRotation">

            <summary>

            Property to get the local rotation. 

            Use method <see cref="M:Delta.Rendering.SceneGraph.SceneGraphNode.GetLocalRotation(Delta.Utilities.Datatypes.Vector@)"/> for performance.

            </summary>

        </member>

        <member name="P:Delta.Rendering.SceneGraph.SceneGraphNode.LocalScale">

            <summary>

            Get or Sets the local scale. 

            Use method <see cref="M:Delta.Rendering.SceneGraph.SceneGraphNode.GetLocalScale(Delta.Utilities.Datatypes.Vector@)"/> for performance.

            </summary>

        </member>

        <member name="P:Delta.Rendering.SceneGraph.SceneGraphNode.WorldPosition">

            <summary>

            Gets the world position. 

            Use method <see cref="M:Delta.Rendering.SceneGraph.SceneGraphNode.GetWorldPosition(Delta.Utilities.Datatypes.Vector@)"/> for performance.

            </summary>

        </member>

        <member name="P:Delta.Rendering.SceneGraph.SceneGraphNode.WorldRotation">

            <summary>

            Property to get the world rotation. 

            Use method <see cref="M:Delta.Rendering.SceneGraph.SceneGraphNode.GetWorldRotation(Delta.Utilities.Datatypes.Vector@)"/> for performance.

            </summary>

        </member>

        <member name="P:Delta.Rendering.SceneGraph.SceneGraphNode.WorldScale">

            <summary>

            Gets the world scale. 

            Use method <see cref="M:Delta.Rendering.SceneGraph.SceneGraphNode.GetWorldScale(Delta.Utilities.Datatypes.Vector@)"/> for performance.

            </summary>

        </member>

        <member name="P:Delta.Rendering.SceneGraph.SceneGraphNode.LocalTransformation">

            <summary>

            Local transformation matrix, copy value type. 

            Use method <see cref="M:Delta.Rendering.SceneGraph.SceneGraphNode.GetLocalTransformation(Delta.Utilities.Datatypes.Matrix@)"/> for performance.

            </summary>

        </member>

        <member name="P:Delta.Rendering.SceneGraph.SceneGraphNode.WorldTransformation">

            <summary>

            World transformation matrix, copy value type. 

            Use method <see cref="M:Delta.Rendering.SceneGraph.SceneGraphNode.GetWorldTransformation(Delta.Utilities.Datatypes.Matrix@)"/> for performance.

            </summary>

        </member>

        <member name="P:Delta.Rendering.SceneGraph.SceneGraphNode.Recalculate">

            <summary>

            If recalculate is true, UpdateTransformation recalculates world matrix.

            </summary>

        </member>

        <member name="M:Delta.Rendering.SceneGraph.SceneGraphNodeGeometry.#ctor(Delta.Graphics.Basics.Geometry,Delta.Rendering.BaseMaterial)">

            <summary>

            Constructor for Geometry and Material.

            </summary>

            <param name="geometry">Geometry to be rendered.</param>

            <param name="material">Matrial in which the Geometry in rendered</param>

        </member>

        <member name="M:Delta.Rendering.SceneGraph.SceneGraphNodeGeometry.#ctor(Delta.ContentSystem.Rendering.GeometryData,Delta.Rendering.BaseMaterial)">

            <summary>

            Constructor for GeometryData and Material.

            Constructs the Geometry from GeometryData automatically.

            </summary>

            <param name="geometryData">Geometry Data</param>

            <param name="material">Material</param>

        </member>

        <member name="M:Delta.Rendering.SceneGraph.SceneGraphNodeGeometry.#ctor">

            <summary>

            Constructor for classes that inherit this.

            </summary>

        </member>

        <member name="M:Delta.Rendering.SceneGraph.SceneGraphNodeGeometry.Render">

            <summary>

            Overriden Render method to render the geometry based on set material.

            </summary>

        </member>

        <member name="P:Delta.Rendering.SceneGraph.SceneGraphNodeGeometry.Geometry">

            <summary>

            Gets or Sets the Geometry to be rendered.

            </summary>

        </member>

        <member name="P:Delta.Rendering.SceneGraph.SceneGraphNodeGeometry.GeometryData">

            <summary>

            Geometry data inside Geomertry to be rendered. 

            Basically just a wrapper to Geometry property.

            </summary>

        </member>

        <member name="P:Delta.Rendering.SceneGraph.SceneGraphNodeGeometry.Material">

            <summary>

            Gets or Sets the Material in which the Geometry is rendered.

            </summary>

        </member>

        <member name="T:Delta.Rendering.SceneGraph.ChildrenRenderOrder">

            <summary>

            Child node render order.

            </summary>

        </member>

        <member name="T:Delta.Rendering.SceneGraph.SceneGraphNodeCamera">

            <summary>

            SceneGraphNode for wrapping a Camera.

            </summary>

        </member>

        <member name="M:Delta.Rendering.SceneGraph.SceneGraphNodeCamera.#ctor(Delta.Rendering.Cameras.BaseCamera)">

            <summary>

            Creates a new instance of <see cref="T:Delta.Rendering.SceneGraph.SceneGraphNodeCamera"/>

            </summary>

            <param name="camera">The camera attached to this node.</param>

        </member>

        <member name="M:Delta.Rendering.SceneGraph.SceneGraphNodeCamera.UpdateTransformation">

            <summary>

            Overridden UpdateTranformation method for settings the world 

            position/rotation for the camera.

            </summary>

            <returns>True if transform was updated, otherwise False.</returns>

        </member>

        <member name="P:Delta.Rendering.SceneGraph.SceneGraphNodeCamera.Camera">

            <summary>

            Camera to be wrapped.

            </summary>

        </member>

        <member name="T:Delta.Rendering.SceneGraph.SceneGraphNodeMesh">

            <summary>

            SceneGraphNode for Mesh based data.

            </summary>

        </member>

        <member name="M:Delta.Rendering.SceneGraph.SceneGraphNodeMesh.#ctor(Delta.Rendering.Models.Mesh)">

            <summary>

            Creates a new instance of <see cref="T:Delta.Rendering.SceneGraph.SceneGraphNodeMesh"/>.

            </summary>

            <param name="mesh">Mesh to be rendered.</param>

        </member>

        <member name="M:Delta.Rendering.SceneGraph.SceneGraphNodeMesh.#ctor">

            <summary>

            Creates a new instance of <see cref="T:Delta.Rendering.SceneGraph.SceneGraphNodeMesh"/>.

            </summary>

            <remarks>

            You need to set the Mesh later for correct rendering.

            </remarks>

        </member>

        <member name="M:Delta.Rendering.SceneGraph.SceneGraphNodeMesh.Render">

            <summary>

            Overriden Render method to render the Mesh.

            </summary>

        </member>

        <member name="P:Delta.Rendering.SceneGraph.SceneGraphNodeMesh.Mesh">

            <summary>

            Gets or Sets the <see cref="P:Delta.Rendering.SceneGraph.SceneGraphNodeMesh.Mesh"/> to be rendered.

            </summary>

        </member>

    </members>

</doc>