urho3d.UrhoSharp/Docs/Urho/UrhoObject.xml

<Type Name="UrhoObject" FullName="Urho.UrhoObject">
  <TypeSignature Language="C#" Value="public class UrhoObject : Urho.RefCounted" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit UrhoObject extends Urho.RefCounted" />
  <AssemblyInfo>
    <AssemblyName>Urho</AssemblyName>
    <AssemblyVersion>1.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>Urho.RefCounted</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary>
            Base class for objects with type identification, subsystem access and event sending/receiving capability.
            </summary>
    <remarks>To be added.</remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public UrhoObject (IntPtr handle);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(native int handle) cil managed" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters>
        <Parameter Name="handle" Type="System.IntPtr" />
      </Parameters>
      <Docs>
        <param name="handle">Pointer to the raw unmanaged Urho object.</param>
        <summary>Constructs a new instance of Urho.UrhoObject, given a raw pointer to an unmanaged object</summary>
        <remarks>
          <para>This creates a new managed wrapper for the type using the raw pointer to an unmanaged object.</para>
          <para>Objects that are created in this fashion get registered with the UrhoSharp runtime.</para>
          <para>This is intended to be used by the UrhoSharp runtime, and is not intended to be used by users.</para>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="protected UrhoObject (Urho.UrhoObjectFlag emptyFlag);" />
      <MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor(valuetype Urho.UrhoObjectFlag emptyFlag) cil managed" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters>
        <Parameter Name="emptyFlag" Type="Urho.UrhoObjectFlag" />
      </Parameters>
      <Docs>
        <param name="emptyFlag">Pass UrhoObjectFlag.Empty.</param>
        <summary>Empty constructor, chain to this constructor when you provide your own constructor that sets the handle field.</summary>
        <remarks>
          <para>This constructor should be invoked by your code if you provide your own constructor that sets the handle field.</para>
          <para>This essentially circumvents the default path that creates a new object and sets the handle and does not call RegisterObject on the target, you must do this on your own constructor.</para>
          <para>You would typically chain to this constructor from your own, and then set the handle to the unmanaged object from your code, and then register your object.</para>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="Category">
      <MemberSignature Language="C#" Value="public string Category { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string Category" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Return object category. Categories are (optionally) registered along with the object factory. Return an empty string if the object category is not registered.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Context">
      <MemberSignature Language="C#" Value="public Urho.Context Context { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class Urho.Context Context" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Urho.Context</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Return execution context.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="EventHandler">
      <MemberSignature Language="C#" Value="public IntPtr EventHandler { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance native int EventHandler" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.IntPtr</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Return active event handler. Null outside event handling.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="EventSender">
      <MemberSignature Language="C#" Value="public Urho.UrhoObject EventSender { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class Urho.UrhoObject EventSender" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Urho.UrhoObject</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Return active event sender. Null outside event handling.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="GetSubsystem">
      <MemberSignature Language="C#" Value="public Urho.UrhoObject GetSubsystem (Urho.StringHash type);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Urho.UrhoObject GetSubsystem(valuetype Urho.StringHash type) cil managed" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Urho.UrhoObject</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="type" Type="Urho.StringHash" />
      </Parameters>
      <Docs>
        <param name="type">To be added.</param>
        <summary>
            Return subsystem by type.
            </summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="HasEventHandlers">
      <MemberSignature Language="C#" Value="public bool HasEventHandlers ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool HasEventHandlers() cil managed" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>
            Return whether has subscribed to any event.
            </summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="HasSubscribedToEvent">
      <MemberSignature Language="C#" Value="public bool HasSubscribedToEvent (Urho.StringHash eventType);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool HasSubscribedToEvent(valuetype Urho.StringHash eventType) cil managed" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="eventType" Type="Urho.StringHash" />
      </Parameters>
      <Docs>
        <param name="eventType">To be added.</param>
        <summary>
            Return whether has subscribed to an event without specific sender.
            </summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="HasSubscribedToEvent">
      <MemberSignature Language="C#" Value="public bool HasSubscribedToEvent (Urho.UrhoObject sender, Urho.StringHash eventType);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool HasSubscribedToEvent(class Urho.UrhoObject sender, valuetype Urho.StringHash eventType) cil managed" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="sender" Type="Urho.UrhoObject" />
        <Parameter Name="eventType" Type="Urho.StringHash" />
      </Parameters>
      <Docs>
        <param name="sender">To be added.</param>
        <param name="eventType">To be added.</param>
        <summary>
            Return whether has subscribed to a specific sender's event.
            </summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="IsInstanceOf">
      <MemberSignature Language="C#" Value="public bool IsInstanceOf (Urho.StringHash type);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool IsInstanceOf(valuetype Urho.StringHash type) cil managed" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="type" Type="Urho.StringHash" />
      </Parameters>
      <Docs>
        <param name="type">To be added.</param>
        <summary>To be added.</summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="IsInstanceOf">
      <MemberSignature Language="C#" Value="public bool IsInstanceOf (Urho.TypeInfo* typeInfo);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool IsInstanceOf(valuetype Urho.TypeInfo* typeInfo) cil managed" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="typeInfo" Type="Urho.TypeInfo*" />
      </Parameters>
      <Docs>
        <param name="typeInfo">To be added.</param>
        <summary>To be added.</summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="IsTypeOf">
      <MemberSignature Language="C#" Value="public static bool IsTypeOf (Urho.StringHash type);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig bool IsTypeOf(valuetype Urho.StringHash type) cil managed" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="type" Type="Urho.StringHash" />
      </Parameters>
      <Docs>
        <param name="type">To be added.</param>
        <summary>To be added.</summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="IsTypeOf">
      <MemberSignature Language="C#" Value="public static bool IsTypeOf (Urho.TypeInfo* typeInfo);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig bool IsTypeOf(valuetype Urho.TypeInfo* typeInfo) cil managed" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="typeInfo" Type="Urho.TypeInfo*" />
      </Parameters>
      <Docs>
        <param name="typeInfo">To be added.</param>
        <summary>To be added.</summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="SendEvent">
      <MemberSignature Language="C#" Value="public void SendEvent (Urho.StringHash eventType);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SendEvent(valuetype Urho.StringHash eventType) cil managed" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="eventType" Type="Urho.StringHash" />
      </Parameters>
      <Docs>
        <param name="eventType">To be added.</param>
        <summary>
            Send event to all subscribers.
            </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="SubscribeToEvent">
      <MemberSignature Language="C#" Value="public void SubscribeToEvent (Urho.StringHash eventType, IntPtr handler);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SubscribeToEvent(valuetype Urho.StringHash eventType, native int handler) cil managed" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="eventType" Type="Urho.StringHash" />
        <Parameter Name="handler" Type="System.IntPtr" />
      </Parameters>
      <Docs>
        <param name="eventType">To be added.</param>
        <param name="handler">To be added.</param>
        <summary>
            Subscribe to an event that can be sent by any sender.
            </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="SubscribeToEvent">
      <MemberSignature Language="C#" Value="public void SubscribeToEvent (Urho.UrhoObject sender, Urho.StringHash eventType, IntPtr handler);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SubscribeToEvent(class Urho.UrhoObject sender, valuetype Urho.StringHash eventType, native int handler) cil managed" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="sender" Type="Urho.UrhoObject" />
        <Parameter Name="eventType" Type="Urho.StringHash" />
        <Parameter Name="handler" Type="System.IntPtr" />
      </Parameters>
      <Docs>
        <param name="sender">To be added.</param>
        <param name="eventType">To be added.</param>
        <param name="handler">To be added.</param>
        <summary>
            Subscribe to a specific sender's event.
            </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Type">
      <MemberSignature Language="C#" Value="public virtual Urho.StringHash Type { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance valuetype Urho.StringHash Type" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Urho.StringHash</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Urho's type system type.</summary>
        <value>StringHash representing the type for this C# type.</value>
        <remarks>This returns the Urho's type and is surfaced for low-level Urho code.</remarks>
      </Docs>
    </Member>
    <Member MemberName="TypeInfo">
      <MemberSignature Language="C#" Value="public Urho.TypeInfo* TypeInfo { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance valuetype Urho.TypeInfo* TypeInfo" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Urho.TypeInfo*</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>To be added.</summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="TypeInfoStatic">
      <MemberSignature Language="C#" Value="public static Urho.TypeInfo* TypeInfoStatic { get; }" />
      <MemberSignature Language="ILAsm" Value=".property valuetype Urho.TypeInfo* TypeInfoStatic" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Urho.TypeInfo*</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>To be added.</summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="TypeName">
      <MemberSignature Language="C#" Value="public virtual string TypeName { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string TypeName" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Urho's low-level type name.</summary>
        <value>Stringified low-level type name.</value>
        <remarks></remarks>
      </Docs>
    </Member>
    <Member MemberName="UnsubscribeFromAllEvents">
      <MemberSignature Language="C#" Value="public void UnsubscribeFromAllEvents ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void UnsubscribeFromAllEvents() cil managed" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>
            Unsubscribe from all events.
            </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="UnsubscribeFromEvent">
      <MemberSignature Language="C#" Value="public void UnsubscribeFromEvent (Urho.StringHash eventType);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void UnsubscribeFromEvent(valuetype Urho.StringHash eventType) cil managed" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="eventType" Type="Urho.StringHash" />
      </Parameters>
      <Docs>
        <param name="eventType">To be added.</param>
        <summary>
            Unsubscribe from an event.
            </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="UnsubscribeFromEvent">
      <MemberSignature Language="C#" Value="public void UnsubscribeFromEvent (Urho.UrhoObject sender, Urho.StringHash eventType);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void UnsubscribeFromEvent(class Urho.UrhoObject sender, valuetype Urho.StringHash eventType) cil managed" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="sender" Type="Urho.UrhoObject" />
        <Parameter Name="eventType" Type="Urho.StringHash" />
      </Parameters>
      <Docs>
        <param name="sender">To be added.</param>
        <param name="eventType">To be added.</param>
        <summary>
            Unsubscribe from a specific sender's event.
            </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="UnsubscribeFromEvents">
      <MemberSignature Language="C#" Value="public void UnsubscribeFromEvents (Urho.UrhoObject sender);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void UnsubscribeFromEvents(class Urho.UrhoObject sender) cil managed" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="sender" Type="Urho.UrhoObject" />
      </Parameters>
      <Docs>
        <param name="sender">To be added.</param>
        <summary>
            Unsubscribe from a specific sender's events.
            </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>