mirror of
https://github.com/sbrl/Nibriboard.git
synced 2018-01-10 21:33:49 +00:00
Add intellisense description to each core structure class.
This commit is contained in:
parent
bd2932832b
commit
c9bd9b3219
6 changed files with 23 additions and 0 deletions
|
@ -1,6 +1,9 @@
|
|||
using System;
|
||||
namespace Nibriboard.RippleSpace
|
||||
{
|
||||
/// <summary>
|
||||
/// Represents a single chunk of an infinite <see cref="Nibriboard.RippleSpace.Plane" />.
|
||||
/// </summary>
|
||||
public class Chunk
|
||||
{
|
||||
public Chunk()
|
||||
|
|
|
@ -1,6 +1,14 @@
|
|||
using System;
|
||||
namespace Nibriboard.RippleSpace
|
||||
{
|
||||
/// <summary>
|
||||
/// References the location of a chunk.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// Defaults to chunk-space, but absolute plane-space can also be calculated
|
||||
/// and obtained (A <see cref="Nibriboard.RippleSpace.LocationReference" />
|
||||
/// is returned).
|
||||
/// </remarks>
|
||||
public class ChunkReference : Reference
|
||||
{
|
||||
public ChunkReference()
|
||||
|
|
|
@ -1,6 +1,9 @@
|
|||
using System;
|
||||
namespace Nibriboard.RippleSpace
|
||||
{
|
||||
/// <summary>
|
||||
/// Represents a line drawn across the plane.
|
||||
/// </summary>
|
||||
public class DrawnLine
|
||||
{
|
||||
public DrawnLine()
|
||||
|
|
|
@ -1,6 +1,9 @@
|
|||
using System;
|
||||
namespace Nibriboard.RippleSpace
|
||||
{
|
||||
/// <summary>
|
||||
/// Represents a location in absolute plane-space.
|
||||
/// </summary>
|
||||
public class LocationReference : Reference
|
||||
{
|
||||
public LocationReference()
|
||||
|
|
|
@ -1,6 +1,9 @@
|
|||
using System;
|
||||
namespace Nibriboard.RippleSpace
|
||||
{
|
||||
/// <summary>
|
||||
/// Represents an infinite plane.
|
||||
/// </summary>
|
||||
public class Plane
|
||||
{
|
||||
public Plane()
|
||||
|
|
|
@ -2,6 +2,9 @@
|
|||
using System.Security.Policy;
|
||||
namespace Nibriboard.RippleSpace
|
||||
{
|
||||
/// <summary>
|
||||
/// An abstract class representing a coordinate reference to a location.
|
||||
/// </summary>
|
||||
public abstract class Reference
|
||||
{
|
||||
public int X { get; set; }
|
||||
|
|
Loading…
Reference in a new issue