TINMAN 3D / REALTIME TERRAIN
Software Development Kit - User Manual

interface IDocumentNode in Tinman.Core.Document

Base interface for nodes in a text document.

interface IDocumentNode extends ICodeOutput
  ISerializable
  IValidatable
  base of DocumentNode
  IBlockNode
  IConfigDocNode
  IInlineNode

Attributes

IsEmpty

Is this document node empty, i.e. it does not contain any visual content?

property IsEmpty { get }
type bool
value true if this document node is empty, false if not.

SerialType

Returns the serial type of this object.

property SerialType { get }
type ISerialTypeInfo
value [not-null] The serial type.
inherited ISerializable.SerialType

SerialVersion

Returns the serial data version.

property SerialVersion { get }
type int32
value [>=1] The serial data version tag.
inherited ISerializable.SerialVersion

Remarks:

An ISerializable implementation is required to support all versions up to the one returned by SerialVersion.

See also:

ISerializable.Serialize
ISerializable.Deserialize

Methods

Accept

Accepts the given node visitor.

method Accept (IDocumentNodeVisitor visitor, object userData)
params visitor The visitor to accept. If null the method shall return silently.
  userData Optional user data object.

Exceptions:

Deserialize

Initializes the state of this object from the given data stream.

method Deserialize (int32 serialVersion, ISerializer data)
type ISerializable
params serialVersion [>=1] The serial data version.
  data [not-null] The serial data stream.
returns [not-null] The deserialized object. This will typically be this, but in some circumstances, another instance may be returned (e.g. singletons).
inherited ISerializable.Deserialize

Remarks:

The Deserialize method will be called immediately after the object has been instantiated via its default constructor.

The provided serialVersion number is guaranteed to be equal to or less than the SerialVersion returned by this object (i.e. ISerializable object must provide backwards compatibility).

See also:

ISerializable.Serialize
ISerializable.SerialVersion

Exceptions:

Serialize

Serializes the current state of this object to the given data stream.

method Serialize (ISerializer data)
params data [not-null] The serial data stream.
inherited ISerializable.Serialize

See also:

ISerializable.Deserialize
ISerializable.SerialVersion

Exceptions:

Validate

Validates the state of this object.

method Validate (Validator validator)
params validator [not-null] The validator object.
inherited IValidatable.Validate

WriteSourceCode

Produces source code by feeding the given source code writer.

method WriteSourceCode (SourceCodeWriter writer, Context context)
params writer [not-null] The source code writer to use.
  context [not-null] Context information.
inherited ICodeOutput.WriteSourceCode

Exceptions: