PageRenderTime 104ms CodeModel.GetById 61ms app.highlight 7ms RepoModel.GetById 33ms app.codeStats 0ms

/Dlls/Delta.Rendering.SceneGraph.xml

#
XML | 432 lines | 432 code | 0 blank | 0 comment | 0 complexity | a64bb29b0d89b668dd20d2ce43decb60 MD5 | raw file
  1<?xml version="1.0"?>
  2<doc>
  3    <assembly>
  4        <name>Delta.Rendering.SceneGraph</name>
  5    </assembly>
  6    <members>
  7        <member name="T:Delta.Rendering.SceneGraph.SceneGraphNodeGeometry">
  8            <summary>
  9            SceneGraphNode for Geometry and Material based data.
 10            </summary>
 11        </member>
 12        <member name="T:Delta.Rendering.SceneGraph.SceneGraphNode">
 13            <summary>
 14            Represents Node that can be part of global Scene hierarchy.
 15            Note that every SceneNode can have more than one children.
 16            </summary>
 17        </member>
 18        <member name="F:Delta.Rendering.SceneGraph.SceneGraphNode.lockObject">
 19            <summary>
 20            Sync object to be locked during RenderAll
 21            </summary>
 22        </member>
 23        <member name="F:Delta.Rendering.SceneGraph.SceneGraphNode.worldTransformation">
 24            <summary>
 25            Matrix combined with Parent local transformation.
 26            </summary>
 27        </member>
 28        <member name="F:Delta.Rendering.SceneGraph.SceneGraphNode.localPosition">
 29            <summary>
 30            Local position of this node.
 31            </summary>
 32        </member>
 33        <member name="F:Delta.Rendering.SceneGraph.SceneGraphNode.localRotation">
 34            <summary>
 35            Local rotation of this node.
 36            </summary>
 37        </member>
 38        <member name="F:Delta.Rendering.SceneGraph.SceneGraphNode.localScale">
 39            <summary>
 40            Local scale of this node.
 41            </summary>
 42        </member>
 43        <member name="F:Delta.Rendering.SceneGraph.SceneGraphNode.localTransformation">
 44            <summary>
 45            Local transformation of this node.
 46            </summary>
 47        </member>
 48        <member name="F:Delta.Rendering.SceneGraph.SceneGraphNode.recalculate">
 49            <summary>
 50            Value that indicates whether to calculate the full transformation.
 51            </summary>
 52        </member>
 53        <member name="F:Delta.Rendering.SceneGraph.SceneGraphNode.children">
 54            <summary>
 55            List containing all children of this node.
 56            </summary>
 57        </member>
 58        <member name="M:Delta.Rendering.SceneGraph.SceneGraphNode.#ctor">
 59            <summary>
 60            Creates a new instance of <see cref="T:Delta.Rendering.SceneGraph.SceneGraphNode"/>
 61            </summary>
 62        </member>
 63        <member name="M:Delta.Rendering.SceneGraph.SceneGraphNode.ResetLocal">
 64            <summary>
 65            Resets the node to original values.
 66            </summary>
 67        </member>
 68        <member name="M:Delta.Rendering.SceneGraph.SceneGraphNode.Add(Delta.Rendering.SceneGraph.SceneGraphNode)">
 69            <summary>
 70            Add a new node to the end of the child node list.
 71            </summary>
 72            <param name="toAdd">Node to add.</param>
 73        </member>
 74        <member name="M:Delta.Rendering.SceneGraph.SceneGraphNode.Add(System.Collections.Generic.IEnumerable{Delta.Rendering.SceneGraph.SceneGraphNode})">
 75            <summary>
 76            Adds an enumerable list of SceneGraphNode to this node.
 77            </summary>
 78            <param name="toAdd">Nodes to add.</param>
 79        </member>
 80        <member name="M:Delta.Rendering.SceneGraph.SceneGraphNode.Insert(System.Int32,Delta.Rendering.SceneGraph.SceneGraphNode)">
 81            <summary>
 82            Inserts node at specific position.
 83            </summary>
 84            <param name="index">Index where to insert.</param>
 85            <param name="toAdd">Node to add.</param>
 86        </member>
 87        <member name="M:Delta.Rendering.SceneGraph.SceneGraphNode.Insert(System.Int32,System.Collections.Generic.IEnumerable{Delta.Rendering.SceneGraph.SceneGraphNode})">
 88            <summary>
 89            Inserts enumerable list of nodes at specific location.
 90            </summary>
 91            <param name="index">Index where to insert.</param>
 92            <param name="toAdd">Nodes to add.</param>
 93        </member>
 94        <member name="M:Delta.Rendering.SceneGraph.SceneGraphNode.Remove(Delta.Rendering.SceneGraph.SceneGraphNode)">
 95            <summary>
 96            Removes child node.
 97            </summary>
 98            <param name="toRemove">Node to remove.</param>
 99            <returns>True if remove succeeded.</returns>
100        </member>
101        <member name="M:Delta.Rendering.SceneGraph.SceneGraphNode.RemoveAt(System.Int32)">
102            <summary>
103            Removes child node at index.
104            </summary>
105            <param name="index">Index where to remove.</param>
106        </member>
107        <member name="M:Delta.Rendering.SceneGraph.SceneGraphNode.RemoveFromParent">
108            <summary>
109            Removes this node from parent.
110            </summary>
111        </member>
112        <member name="M:Delta.Rendering.SceneGraph.SceneGraphNode.Clear">
113            <summary>
114            Removes all child nodes.
115            </summary>
116        </member>
117        <member name="M:Delta.Rendering.SceneGraph.SceneGraphNode.GetLocalPosition(Delta.Utilities.Datatypes.Vector@)">
118            <summary>
119            Method to get the local position.
120            </summary>
121            <param name="whereToSet">Where to store the position.</param>
122        </member>
123        <member name="M:Delta.Rendering.SceneGraph.SceneGraphNode.SetLocalPosition(Delta.Utilities.Datatypes.Vector@)">
124            <summary>
125            Set the local position.
126            </summary>
127            <param name="toSet">What to set.</param>
128        </member>
129        <member name="M:Delta.Rendering.SceneGraph.SceneGraphNode.SetLocalPosition(System.Single,System.Single,System.Single)">
130            <summary>
131            Set local position.
132            </summary>
133            <param name="x">X coordinate.</param>
134            <param name="y">Y coordinate.</param>
135            <param name="z">Z coordinate.</param>
136        </member>
137        <member name="M:Delta.Rendering.SceneGraph.SceneGraphNode.OffsetLocalPosition(Delta.Utilities.Datatypes.Vector@)">
138            <summary>
139            Offset the local position with given value.
140            </summary>
141            <param name="toSet">What to offset.</param>
142            <param name="toOffset">Offset</param>
143        </member>
144        <member name="M:Delta.Rendering.SceneGraph.SceneGraphNode.OffsetLocalPosition(System.Single,System.Single,System.Single)">
145            <summary>
146            Method to offset local position.
147            </summary>
148            <param name="x">X coordinate.</param>
149            <param name="y">Y coordinate.</param>
150            <param name="z">Z coordinate.</param>
151        </member>
152        <member name="M:Delta.Rendering.SceneGraph.SceneGraphNode.GetLocalRotation(Delta.Utilities.Datatypes.Vector@)">
153            <summary>
154            Method to get the local rotation.
155            </summary>
156            <param name="whereToSet">Where to store the rotation.</param>
157        </member>
158        <member name="M:Delta.Rendering.SceneGraph.SceneGraphNode.SetLocalRotation(Delta.Utilities.Datatypes.Vector@)">
159            <summary>
160            Method to set the local rotation.
161            </summary>
162            <param name="toSet">What to set.</param>
163        </member>
164        <member name="M:Delta.Rendering.SceneGraph.SceneGraphNode.SetLocalRotation(System.Single,System.Single,System.Single)">
165            <summary>
166            Method to set local rotation.
167            </summary>
168            <param name="x">X coordinate.</param>
169            <param name="y">Y coordinate.</param>
170            <param name="z">Z coordinate.</param>
171        </member>
172        <member name="M:Delta.Rendering.SceneGraph.SceneGraphNode.GetLocalScale(Delta.Utilities.Datatypes.Vector@)">
173            <summary>
174            Method to get the local scale.
175            </summary>
176            <param name="whereToSet">Where to store the scale.</param>
177        </member>
178        <member name="M:Delta.Rendering.SceneGraph.SceneGraphNode.SetLocalScale(Delta.Utilities.Datatypes.Vector@)">
179            <summary>
180            Method for setting the local scale.
181            </summary>
182            <param name="toSet">What to set.</param>
183        </member>
184        <member name="M:Delta.Rendering.SceneGraph.SceneGraphNode.SetLocalScale(System.Single,System.Single,System.Single)">
185            <summary>
186            Method for setting local scale.
187            </summary>
188            <param name="x">X coordinate.</param>
189            <param name="y">Y coordinate.</param>
190            <param name="z">Z coordinate.</param>
191        </member>
192        <member name="M:Delta.Rendering.SceneGraph.SceneGraphNode.GetLocalTransformation(Delta.Utilities.Datatypes.Matrix@)">
193            <summary>
194            Method to get the local transformation matrix.
195            </summary>
196            <param name="whereToGet">Where the local matrix is stored.</param>
197        </member>
198        <member name="M:Delta.Rendering.SceneGraph.SceneGraphNode.GetWorldTransformation(Delta.Utilities.Datatypes.Matrix@)">
199            <summary>
200            Method to get the world transformation matrix.
201            </summary>
202            <param name="whereToGet">Where the world matrix is stored.</param>
203        </member>
204        <member name="M:Delta.Rendering.SceneGraph.SceneGraphNode.GetWorldPosition(Delta.Utilities.Datatypes.Vector@)">
205            <summary>
206            Method to get the world position of the node.
207            </summary>
208            <param name="whereToSet">Where to store the position.</param>
209        </member>
210        <member name="M:Delta.Rendering.SceneGraph.SceneGraphNode.GetWorldRotation(Delta.Utilities.Datatypes.Vector@)">
211            <summary>
212            Method to getting the world rotation.
213            </summary>
214            <param name="whereToSet">Where to store the rotation.</param>
215        </member>
216        <member name="M:Delta.Rendering.SceneGraph.SceneGraphNode.GetWorldScale(Delta.Utilities.Datatypes.Vector@)">
217             <summary>
218            Get the world scale.
219             </summary>
220             <param name="whereToSet">Where to store the scale.</param>
221        </member>
222        <member name="M:Delta.Rendering.SceneGraph.SceneGraphNode.Render">
223            <summary>
224            Render method to be called when this node is to be rendered. 
225            Override if you need to render this node.
226            </summary>
227        </member>
228        <member name="M:Delta.Rendering.SceneGraph.SceneGraphNode.RenderAll">
229            <summary>
230            Renders all child nodes and this node.
231            </summary>
232        </member>
233        <member name="M:Delta.Rendering.SceneGraph.SceneGraphNode.UpdateTransformation">
234            <summary>
235            Updates local and world transformation if needed, so if Recalculate is 
236            true then it is recalculated.
237            </summary>
238            <returns>
239            True if the matrices were recalculated.
240            </returns>
241        </member>
242        <member name="M:Delta.Rendering.SceneGraph.SceneGraphNode.CheckDepth(Delta.Rendering.SceneGraph.SceneGraphNode)">
243            <summary>
244            Checks the node depth.
245            </summary>
246            <param name="toCheck">Graph node to check.</param>
247        </member>
248        <member name="P:Delta.Rendering.SceneGraph.SceneGraphNode.RenderOrder">
249            <summary>
250            This property sets the child node render order. If ChildrenFirst then
251            child nodes are processed first and then the current node, ChildrenLast
252            is the opposite.
253            </summary>
254        </member>
255        <member name="P:Delta.Rendering.SceneGraph.SceneGraphNode.Parent">
256            <summary>
257            Gets the parent of this node.
258            </summary>
259        </member>
260        <member name="P:Delta.Rendering.SceneGraph.SceneGraphNode.Root">
261            <summary>
262            Property to get the root node.
263            </summary>
264        </member>
265        <member name="P:Delta.Rendering.SceneGraph.SceneGraphNode.Depth">
266            <summary>
267            Gets the depth of the tree beginning from this node.
268            </summary>
269        </member>
270        <member name="P:Delta.Rendering.SceneGraph.SceneGraphNode.ChildrenCount">
271            <summary>
272            Gets the children count.
273            </summary>
274        </member>
275        <member name="P:Delta.Rendering.SceneGraph.SceneGraphNode.Children">
276            <summary>
277            Gets enumerator of all children of this node.
278            </summary>
279        </member>
280        <member name="P:Delta.Rendering.SceneGraph.SceneGraphNode.LocalPosition">
281            <summary>
282            Gets or Sets the local position. 
283            Use method <see cref="M:Delta.Rendering.SceneGraph.SceneGraphNode.GetLocalPosition(Delta.Utilities.Datatypes.Vector@)"/> for performance.
284            </summary>
285        </member>
286        <member name="P:Delta.Rendering.SceneGraph.SceneGraphNode.LocalRotation">
287            <summary>
288            Property to get the local rotation. 
289            Use method <see cref="M:Delta.Rendering.SceneGraph.SceneGraphNode.GetLocalRotation(Delta.Utilities.Datatypes.Vector@)"/> for performance.
290            </summary>
291        </member>
292        <member name="P:Delta.Rendering.SceneGraph.SceneGraphNode.LocalScale">
293            <summary>
294            Get or Sets the local scale. 
295            Use method <see cref="M:Delta.Rendering.SceneGraph.SceneGraphNode.GetLocalScale(Delta.Utilities.Datatypes.Vector@)"/> for performance.
296            </summary>
297        </member>
298        <member name="P:Delta.Rendering.SceneGraph.SceneGraphNode.WorldPosition">
299            <summary>
300            Gets the world position. 
301            Use method <see cref="M:Delta.Rendering.SceneGraph.SceneGraphNode.GetWorldPosition(Delta.Utilities.Datatypes.Vector@)"/> for performance.
302            </summary>
303        </member>
304        <member name="P:Delta.Rendering.SceneGraph.SceneGraphNode.WorldRotation">
305            <summary>
306            Property to get the world rotation. 
307            Use method <see cref="M:Delta.Rendering.SceneGraph.SceneGraphNode.GetWorldRotation(Delta.Utilities.Datatypes.Vector@)"/> for performance.
308            </summary>
309        </member>
310        <member name="P:Delta.Rendering.SceneGraph.SceneGraphNode.WorldScale">
311            <summary>
312            Gets the world scale. 
313            Use method <see cref="M:Delta.Rendering.SceneGraph.SceneGraphNode.GetWorldScale(Delta.Utilities.Datatypes.Vector@)"/> for performance.
314            </summary>
315        </member>
316        <member name="P:Delta.Rendering.SceneGraph.SceneGraphNode.LocalTransformation">
317            <summary>
318            Local transformation matrix, copy value type. 
319            Use method <see cref="M:Delta.Rendering.SceneGraph.SceneGraphNode.GetLocalTransformation(Delta.Utilities.Datatypes.Matrix@)"/> for performance.
320            </summary>
321        </member>
322        <member name="P:Delta.Rendering.SceneGraph.SceneGraphNode.WorldTransformation">
323            <summary>
324            World transformation matrix, copy value type. 
325            Use method <see cref="M:Delta.Rendering.SceneGraph.SceneGraphNode.GetWorldTransformation(Delta.Utilities.Datatypes.Matrix@)"/> for performance.
326            </summary>
327        </member>
328        <member name="P:Delta.Rendering.SceneGraph.SceneGraphNode.Recalculate">
329            <summary>
330            If recalculate is true, UpdateTransformation recalculates world matrix.
331            </summary>
332        </member>
333        <member name="M:Delta.Rendering.SceneGraph.SceneGraphNodeGeometry.#ctor(Delta.Graphics.Basics.Geometry,Delta.Rendering.BaseMaterial)">
334            <summary>
335            Constructor for Geometry and Material.
336            </summary>
337            <param name="geometry">Geometry to be rendered.</param>
338            <param name="material">Matrial in which the Geometry in rendered</param>
339        </member>
340        <member name="M:Delta.Rendering.SceneGraph.SceneGraphNodeGeometry.#ctor(Delta.ContentSystem.Rendering.GeometryData,Delta.Rendering.BaseMaterial)">
341            <summary>
342            Constructor for GeometryData and Material.
343            Constructs the Geometry from GeometryData automatically.
344            </summary>
345            <param name="geometryData">Geometry Data</param>
346            <param name="material">Material</param>
347        </member>
348        <member name="M:Delta.Rendering.SceneGraph.SceneGraphNodeGeometry.#ctor">
349            <summary>
350            Constructor for classes that inherit this.
351            </summary>
352        </member>
353        <member name="M:Delta.Rendering.SceneGraph.SceneGraphNodeGeometry.Render">
354            <summary>
355            Overriden Render method to render the geometry based on set material.
356            </summary>
357        </member>
358        <member name="P:Delta.Rendering.SceneGraph.SceneGraphNodeGeometry.Geometry">
359            <summary>
360            Gets or Sets the Geometry to be rendered.
361            </summary>
362        </member>
363        <member name="P:Delta.Rendering.SceneGraph.SceneGraphNodeGeometry.GeometryData">
364            <summary>
365            Geometry data inside Geomertry to be rendered. 
366            Basically just a wrapper to Geometry property.
367            </summary>
368        </member>
369        <member name="P:Delta.Rendering.SceneGraph.SceneGraphNodeGeometry.Material">
370            <summary>
371            Gets or Sets the Material in which the Geometry is rendered.
372            </summary>
373        </member>
374        <member name="T:Delta.Rendering.SceneGraph.ChildrenRenderOrder">
375            <summary>
376            Child node render order.
377            </summary>
378        </member>
379        <member name="T:Delta.Rendering.SceneGraph.SceneGraphNodeCamera">
380            <summary>
381            SceneGraphNode for wrapping a Camera.
382            </summary>
383        </member>
384        <member name="M:Delta.Rendering.SceneGraph.SceneGraphNodeCamera.#ctor(Delta.Rendering.Cameras.BaseCamera)">
385            <summary>
386            Creates a new instance of <see cref="T:Delta.Rendering.SceneGraph.SceneGraphNodeCamera"/>
387            </summary>
388            <param name="camera">The camera attached to this node.</param>
389        </member>
390        <member name="M:Delta.Rendering.SceneGraph.SceneGraphNodeCamera.UpdateTransformation">
391            <summary>
392            Overridden UpdateTranformation method for settings the world 
393            position/rotation for the camera.
394            </summary>
395            <returns>True if transform was updated, otherwise False.</returns>
396        </member>
397        <member name="P:Delta.Rendering.SceneGraph.SceneGraphNodeCamera.Camera">
398            <summary>
399            Camera to be wrapped.
400            </summary>
401        </member>
402        <member name="T:Delta.Rendering.SceneGraph.SceneGraphNodeMesh">
403            <summary>
404            SceneGraphNode for Mesh based data.
405            </summary>
406        </member>
407        <member name="M:Delta.Rendering.SceneGraph.SceneGraphNodeMesh.#ctor(Delta.Rendering.Models.Mesh)">
408            <summary>
409            Creates a new instance of <see cref="T:Delta.Rendering.SceneGraph.SceneGraphNodeMesh"/>.
410            </summary>
411            <param name="mesh">Mesh to be rendered.</param>
412        </member>
413        <member name="M:Delta.Rendering.SceneGraph.SceneGraphNodeMesh.#ctor">
414            <summary>
415            Creates a new instance of <see cref="T:Delta.Rendering.SceneGraph.SceneGraphNodeMesh"/>.
416            </summary>
417            <remarks>
418            You need to set the Mesh later for correct rendering.
419            </remarks>
420        </member>
421        <member name="M:Delta.Rendering.SceneGraph.SceneGraphNodeMesh.Render">
422            <summary>
423            Overriden Render method to render the Mesh.
424            </summary>
425        </member>
426        <member name="P:Delta.Rendering.SceneGraph.SceneGraphNodeMesh.Mesh">
427            <summary>
428            Gets or Sets the <see cref="P:Delta.Rendering.SceneGraph.SceneGraphNodeMesh.Mesh"/> to be rendered.
429            </summary>
430        </member>
431    </members>
432</doc>