urho3d.UrhoSharp/Docs/Urho.Shapes/Shape.xml

<Type Name="Shape" FullName="Urho.Shapes.Shape">
  <TypeSignature Language="C#" Value="public abstract class Shape : Urho.StaticModel" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit Shape extends Urho.StaticModel" />
  <AssemblyInfo>
    <AssemblyName>Urho</AssemblyName>
    <AssemblyVersion>1.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>Urho.StaticModel</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary>Base class for the shapes in the namespace.</summary>
    <remarks>
      <para>You can subclass this class if you want to create your own shape.  </para>
      <para />
      <para>Shapes are components loaded from a model, and with a convenience <see cref="P:Urho.Shapes.Shape.Color" /> property surfaced that controls the color of the shape.   The color control is implemented by using an <see cref="T:Urho.Technique" /> that is bundled in CoreData called Techniques/NoTextureAlpha.xml and the color is applied by setting the the MatDiffColor shader parameter.</para>
      <para />
      <para>To create your own shape, override the <see cref="T:Urho.Shapes.Shape.ModelResource" /> property to return the path of the model.   The path should be a file that can be located in the CoreData package for your application.</para>
    </remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="protected Shape ();" />
      <MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName>Preserve</AttributeName>
        </Attribute>
      </Attributes>
      <Parameters />
      <Docs>
        <summary>
          <para>Constructs an instance of the type, for internal use.   These types are created by calling <see cref="M:Urho.Node.CreateComponent" /></para>
        </summary>
        <remarks></remarks>
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="protected Shape (IntPtr handle);" />
      <MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor(native int handle) cil managed" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName>Preserve</AttributeName>
        </Attribute>
      </Attributes>
      <Parameters>
        <Parameter Name="handle" Type="System.IntPtr" />
      </Parameters>
      <Docs>
        <param name="handle">To be added.</param>
        <summary>To be added.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Color">
      <MemberSignature Language="C#" Value="public Urho.Color Color { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance valuetype Urho.Color Color" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Urho.Color</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Color for the shape.</summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="ModelResource">
      <MemberSignature Language="C#" Value="protected abstract string ModelResource { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string ModelResource" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Returns the path of the model for this shape, for the shape to work, the MDL file in the CoreData package must exist.</summary>
        <value>To be added.</value>
        <remarks></remarks>
      </Docs>
    </Member>
    <Member MemberName="OnAttachedToNode">
      <MemberSignature Language="C#" Value="public override void OnAttachedToNode (Urho.Node node);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance void OnAttachedToNode(class Urho.Node node) cil managed" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="node" Type="Urho.Node" />
      </Parameters>
      <Docs>
        <param name="node">To be added.</param>
        <summary>Implements OnAttachedToNode.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="OnCloned">
      <MemberSignature Language="C#" Value="public override void OnCloned (Urho.Scene scene, Urho.Component originalComponent);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance void OnCloned(class Urho.Scene scene, class Urho.Component originalComponent) cil managed" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="scene" Type="Urho.Scene" />
        <Parameter Name="originalComponent" Type="Urho.Component" />
      </Parameters>
      <Docs>
        <param name="scene">To be added.</param>
        <param name="originalComponent">To be added.</param>
        <summary>To be added.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="OnDeserialize">
      <MemberSignature Language="C#" Value="public override void OnDeserialize (Urho.Resources.IComponentDeserializer d);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance void OnDeserialize(class Urho.Resources.IComponentDeserializer d) cil managed" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="d" Type="Urho.Resources.IComponentDeserializer" />
      </Parameters>
      <Docs>
        <param name="d">To be added.</param>
        <summary>Deserialization that restores the shape from storage.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="OnSerialize">
      <MemberSignature Language="C#" Value="public override void OnSerialize (Urho.Resources.IComponentSerializer s);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance void OnSerialize(class Urho.Resources.IComponentSerializer s) cil managed" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="s" Type="Urho.Resources.IComponentSerializer" />
      </Parameters>
      <Docs>
        <param name="s">To be added.</param>
        <summary>Serialization that saves the shape from storage.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>