/Dlls/Delta.ContentSystem.UserInterfaces.xml

<?xml version="1.0"?>

<doc>

    <assembly>

        <name>Delta.ContentSystem.UserInterfaces</name>

    </assembly>

    <members>

        <member name="T:Delta.ContentSystem.UserInterfaces.BaseUIScreenData">

            <summary>

            The basic content class which is the base of all UI screen classes. 

            </summary>

        </member>

        <member name="F:Delta.ContentSystem.UserInterfaces.BaseUIScreenData.VersionNumber">

            <summary>

            The newest version number of the screen data.

            </summary>

        </member>

        <member name="M:Delta.ContentSystem.UserInterfaces.BaseUIScreenData.Get(System.String)">

            <summary>

            Get and load content based on the content name. This method makes sure

            we do not load the same content twice (the constructor is protected).

            </summary>

            <param name="contentName">Content name we want to load, this is

            passed onto the Content System, which will do the actual loading with

            help of the Load method in this class.</param>

            <returns>The loaded Content object, always unique for the same

            name, this helps comparing data.</returns>

        </member>

        <member name="F:Delta.ContentSystem.UserInterfaces.BaseUIScreenData.drawArea">

            <summary>

            Draw area

            </summary>

        </member>

        <member name="M:Delta.ContentSystem.UserInterfaces.BaseUIScreenData.#ctor(System.String)">

            <summary>

            Create scene content based on the content system. Loading happens in

            the Load method, all content is loaded right away.

            </summary>

            <param name="setContentName">Name of the scene name to load.</param>

        </member>

        <member name="M:Delta.ContentSystem.UserInterfaces.BaseUIScreenData.Load(System.IO.BinaryReader)">

            <summary>

            Loads all data of the object again which were previously saved.

            </summary>

            <param name="dataReader">

            The container object which contains the data which were saved before.

            </param>

        </member>

        <member name="M:Delta.ContentSystem.UserInterfaces.BaseUIScreenData.Save(System.IO.BinaryWriter)">

            <summary>

            Saves all necessary data of the object into a binary stream.

            </summary>

            <param name="dataWriter">

            The container object which will store all the saved data.

            </param>

        </member>

        <member name="M:Delta.ContentSystem.UserInterfaces.BaseUIScreenData.Load(Delta.ContentSystem.Content)">

            <summary>

            Native load method, will just load the data.

            </summary>

            <param name="alreadyLoadedNativeData">

            The first instance that has already loaded the required content data

            of this content class or just 'null' if there is none loaded yet (or

            anymore).

            </param>

        </member>

        <member name="P:Delta.ContentSystem.UserInterfaces.BaseUIScreenData.DrawArea">

            <summary>

            By default we render to Rectangle.One, which will be converted

            to Graphic.Instance.DrawArea, else use this size as a draw area!

            Note: Only used for UIScene.BackgroundDesign.Draw

            </summary>

        </member>

        <member name="M:Delta.ContentSystem.UserInterfaces.BaseDesignData.Dispose">

            <summary>

            Dispose

            </summary>

        </member>

        <member name="M:Delta.ContentSystem.UserInterfaces.BaseDesignData.Load(System.IO.BinaryReader)">

            <summary>

            Load the design data.

            </summary>

            <param name="reader">Reader</param>

        </member>

        <member name="M:Delta.ContentSystem.UserInterfaces.BaseDesignData.Save(System.IO.BinaryWriter)">

            <summary>

            Save the design data.

            </summary>

            <param name="writer">Writer</param>

        </member>

        <member name="M:Delta.ContentSystem.UserInterfaces.BaseUIThemeData.Get(System.String)">

            <summary>

            Get and load content based on the content name. This method makes sure

            we do not load the same content twice (the constructor is protected).

            </summary>

            <param name="contentName">Content name we want to load, this is

            passed onto the Content System, which will do the actual loading with

            help of the Load method in this class.</param>

            <returns>The loaded Content object, always unique for the same

            name, this helps comparing data.</returns>

        </member>

        <member name="M:Delta.ContentSystem.UserInterfaces.BaseUIThemeData.#ctor(System.String)">

            <summary>

            The content constructor just searches for the ContentMetaData entry

            with the ContentManager.Add method and links it up for this object.

            </summary>

            <param name="setName">Name for this content object, should not contain

            any path, project, scene or any special character! If this is empty

            or starts with an &gt; character, we assume this is code generated

            content (e.g. "&gt;IntroScene&lt;" or "") and no loading will happen!

            </param>

        </member>

        <member name="T:Delta.ContentSystem.UserInterfaces.SceneData">

            <summary>

            Scene data content class, which loads all the required data for a scene.

            Most importantly we always have only one scene active. All content that

            is loaded during the time that scene is open will automatically be

            disposed when closing the scene. This way we can open new scenes and

            make sure all content from the previous scenes has been unloaded. If

            you load new scenes while the old one is still open (stack add), you can

            load additional content, but nothing gets disposed automatically.

            <para />

            Note: This class is not publicly available in the namespace

            Delta.ContentSystem.UserInterfaces because it is sealed and only used

            in the also sealed and protected Scene class (in Delta.Scenes).

            </summary>

        </member>

        <member name="F:Delta.ContentSystem.UserInterfaces.SceneData.VersionNumber">

            <summary>

            The current version of the implementation of this class.

            </summary>

        </member>

        <member name="M:Delta.ContentSystem.UserInterfaces.SceneData.Get(System.String)">

            <summary>

            This is the only method to load SceneData content. If a content object

            has already been loaded, it will be returned again.

            </summary>

            <param name="contentName">Name of the Scene content to load</param>

            <returns>The loaded SceneData object (or fallback if it failed)

            </returns>

        </member>

        <member name="M:Delta.ContentSystem.UserInterfaces.SceneData.#ctor">

            <summary>

            Create scene data, used for the Scene Editor to define the data.

            </summary>

        </member>

        <member name="M:Delta.ContentSystem.UserInterfaces.SceneData.#ctor(System.String)">

            <summary>

            Create scene content based on the content system. Loading happens in

            the Load method, all content is loaded right away.

            </summary>

            <param name="setContentName">Name of the scene name to load.</param>

        </member>

        <member name="M:Delta.ContentSystem.UserInterfaces.SceneData.Load(System.IO.BinaryReader)">

            <summary>

            Loads and restores all previously saved values that belongs to this

            class only from the given data reader.

            </summary>

            <param name="dataReader">The reader which contains the stream with the

            saved data which needs to be loaded now.</param>

        </member>

        <member name="M:Delta.ContentSystem.UserInterfaces.SceneData.Save(System.IO.BinaryWriter)">

            <summary>

            Save data

            </summary>

            <param name="dataWriter">Writer</param>

        </member>

        <member name="M:Delta.ContentSystem.UserInterfaces.SceneData.Load(Delta.ContentSystem.Content)">

            <summary>

            Native load method, will load all the scene data.

            </summary>

            <param name="alreadyLoadedNativeData">

            The first instance that has already loaded the required content data

            of this content class or just 'null' if there is none loaded yet (or

            anymore).

            </param>

        </member>

        <member name="P:Delta.ContentSystem.UserInterfaces.SceneData.LoadingBackgroundImageName">

            <summary>

            Name of the loading background image that will be shown when a scene

            is loading (optional).

            </summary>

        </member>

        <member name="P:Delta.ContentSystem.UserInterfaces.SceneData.Screens">

            <summary>

            The list of screen data which represents the screens which are used in

            the scene if it get loaded.

            </summary>

        </member>

        <member name="P:Delta.ContentSystem.UserInterfaces.SceneData.Theme">

            <summary>

            Theme to be used for this scene and all UI Screens.

            </summary>

        </member>

        <member name="P:Delta.ContentSystem.UserInterfaces.SceneData.MusicName">

            <summary>

            Music name

            </summary>

        </member>

        <member name="P:Delta.ContentSystem.UserInterfaces.SceneData.VideoName">

            <summary>

            Video name

            </summary>

        </member>

        <member name="P:Delta.ContentSystem.UserInterfaces.SceneData.CameraName">

            <summary>

            Camera name

            </summary>

        </member>

        <member name="T:Delta.ContentSystem.UserInterfaces.BaseControlData">

            <summary>

            The data container class which contains the basic data of a control.

            </summary>

        </member>

        <member name="F:Delta.ContentSystem.UserInterfaces.BaseControlData.VersionNumber">

            <summary>

            The version number of the class implementation.

            </summary>

        </member>

        <member name="F:Delta.ContentSystem.UserInterfaces.BaseControlData.rotation">

            <summary>

            Rotation

            </summary>

        </member>

        <member name="M:Delta.ContentSystem.UserInterfaces.BaseControlData.Save(System.IO.BinaryWriter)">

            <summary>

            Saves all necessary data of the object into a binary stream.

            </summary>

            <param name="dataWriter">

            The container object which will store all the saved data.

            </param>

        </member>

        <member name="M:Delta.ContentSystem.UserInterfaces.BaseControlData.Load(System.IO.BinaryReader)">

            <summary>

            Loads all data of the object again which were previously saved.

            </summary>

            <param name="dataReader">

            The container object which contains the data which were saved before.

            </param>

        </member>

        <member name="M:Delta.ContentSystem.UserInterfaces.BaseControlData.Dispose">

            <summary>

            Dispose

            </summary>

        </member>

        <member name="P:Delta.ContentSystem.UserInterfaces.BaseControlData.Name">

            <summary>

            Name of this element.

            </summary>

        </member>

        <member name="P:Delta.ContentSystem.UserInterfaces.BaseControlData.Rotation">

            <summary>

            Faster, but we need to update Parent Rotation ourself

            </summary>

        </member>

        <member name="P:Delta.ContentSystem.UserInterfaces.BaseControlData.ToolTipText">

            <summary>

            The info text about this element.

            </summary>

            <value>The tool tip text.</value>

        </member>

        <member name="P:Delta.ContentSystem.UserInterfaces.BaseControlData.DataBag">

            <summary>

            The "bag" to store any custom data for this element.

            </summary>

        </member>

    </members>

</doc>