Component Class |
Namespace: NeoAxis
public class Component : MetadataIMetadataProvider, IDisposable
The Component type exposes the following members.
Name | Description | |
---|---|---|
![]() | AnyData |
The user data of the component.
|
![]() | BaseType |
Gets the base type of the object.
|
![]() | CloneSupport |
Whether the object supports cloning.
|
![]() | Components |
Gets the collection of the child components.
|
![]() | CreatedByBaseType |
Whether the object is created using a base type.
|
![]() | DisplayInEditor |
Whether to show the object in the editor.
|
![]() | Disposed |
Whether the object is disposed.
|
![]() | EditorDocumentConfiguration |
Gets or sets the configuration data of the object's settings in the editor.
|
![]() | EditorReadOnly |
Whether the object is read only in the editor.
|
![]() | EditorReadOnlyInHierarchy |
Whether the object is read-only in the editor with respect to parent objects.
|
![]() | Enabled |
Whether the component is enabled. Any functionality of component is not works when it disabled.
|
![]() | EnabledInHierarchy |
Determines whether the object is attached to a hierarchy of the components and enabled. The object will be enabled only when all parents are enabled, and the property Enabled is enabled.
|
![]() | EnabledInHierarchyAndIsInstance |
Determines when the object is attached to a hierarchy of the components, is enabled and the object if not part of a resource (it is usual object instance). The object will be enabled only when all parents are enabled, and the property Enabled is enabled.
|
![]() | HierarchyController |
Gets the object hierarchy control controller.
|
![]() | Name |
The name of the component.
|
![]() | NetworkID | |
![]() | NetworkIsClient | |
![]() | NetworkIsServer |
Whether to work in network server mode. It is false until the scene is not loaded.
|
![]() | NetworkIsSingle | |
![]() | NetworkIsSingleOrClient | |
![]() | NetworkMode |
Whether to enable synchronization of the component between server and clients.
|
![]() | NetworkModeUsers | |
![]() | Parent |
Gets the parent object.
|
![]() | ParentRoot |
Gets the parent root object.
|
![]() | RemoveFromParentQueued |
Whether the object is placed in the detach queue from the parent.
|
![]() | SaveSupport |
Whether the object supports saving to a file.
|
![]() | ScreenLabel |
The displaying mode of an on-screen label of the component in the scene editor.
|
![]() | TypeSettingsPrivateObjects |
Object settings when used as a type.
|
Name | Description | |
---|---|---|
![]() | AddComponent |
Adds a component as a child.
|
![]() | BeginNetworkMessage(ServerNetworkService_ComponentsClientItem, String) | |
![]() | BeginNetworkMessage(IListServerNetworkService_ComponentsClientItem, String) | |
![]() | BeginNetworkMessage(ServerNetworkService_UsersUserInfo, String) | |
![]() | BeginNetworkMessage(IListServerNetworkService_UsersUserInfo, String) | |
![]() | BeginNetworkMessageToEveryone | |
![]() | BeginNetworkMessageToServer | |
![]() | Clone |
Creates a copy of the object.
|
![]() | CreateComponent(Type, Int32, Boolean, Boolean, NetworkModeEnum) |
Creates a child component.
|
![]() | CreateComponent(MetadataTypeInfo, Int32, Boolean, Boolean, NetworkModeEnum) |
Creates a child component.
|
![]() | CreateComponentT(Int32, Boolean, Boolean, NetworkModeEnum) |
Creates a child component.
|
![]() | Dispose |
Detaches the object from the hierarchy and deletes the object data.
|
![]() | EndNetworkMessage | |
![]() | Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
![]() | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
![]() | FindParent(Type) |
Finds the parent of the specified type.
|
![]() | FindParent(MetadataTypeInfo) |
Finds the parent of the specified type.
|
![]() | FindParentT |
Finds the parent of the specified type.
|
![]() | FindThisOrParent(Type) |
Finds the parent or self of the specified type.
|
![]() | FindThisOrParent(MetadataTypeInfo) |
Finds the parent or self of the specified type.
|
![]() | FindThisOrParentT |
Finds the parent or self of the specified type.
|
![]() | GetAllParents |
Gets all parents of the component.
|
![]() | GetComponent(String, Boolean) |
Finds a child component by name.
|
![]() | GetComponent(Type, Boolean, Boolean) |
Finds a child component of the specified type.
|
![]() | GetComponent(MetadataTypeInfo, Boolean, Boolean) |
Finds a child component of the specified type.
|
![]() | GetComponentT(Boolean, Boolean) |
Finds a child component of the specified type.
|
![]() | GetComponentT(String, Boolean) |
Finds a child component by name with the specified type.
|
![]() | GetComponentByNameWithIndex |
Finds a child component by name and number in the case when there are several components with the specified name.
|
![]() | GetComponentByPath |
Finds a child component by path.
|
![]() | GetComponents(Boolean, Boolean, Boolean, Boolean) |
Finds child components.
|
![]() | GetComponents(Boolean, Boolean, Boolean, Boolean, ActionComponent) |
Finds child components.
|
![]() | GetComponents(Type, Boolean, Boolean, Boolean, Boolean) |
Finds child components of the specified type.
|
![]() | GetComponents(MetadataTypeInfo, Boolean, Boolean, Boolean, Boolean) |
Finds child components of the specified type.
|
![]() | GetComponentsT(Boolean, Boolean, Boolean, Boolean) |
Finds child components of the specified type.
|
![]() | GetComponentsT(Boolean, Boolean, Boolean, Boolean, ActionT) |
Finds child components of the specified type.
|
![]() | GetHashCode | Serves as the default hash function. (Inherited from Object.) |
![]() | GetPathFromParent |
Returns the path to the object from the parent.
|
![]() | GetPathFromRoot |
Returns the object's access path from the root object.
|
![]() | GetProvidedType |
Returns a type when the object is used as a type.
|
![]() | GetScreenLabelInfo | |
![]() | GetType | Gets the Type of the current instance. (Inherited from Object.) |
![]() | IsMethodInvoking |
Checks if a method is running over time. You can start executing such methods using MethodInvoke(String, Object, Double, Double) method.
|
![]() | MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
![]() | MetadataGetMemberBySignature |
Returns the object metadata member by name.
|
![]() | MetadataGetMembers |
Returns the object metadata members.
|
![]() | MethodInvoke |
Calls a method by name.
|
![]() | MethodInvokeCancel |
Cancels the execution of selected method that run over time. You can start executing such methods using MethodInvoke(String, Object, Double, Double) method.
|
![]() | MethodInvokeCancelAll |
Cancels the execution of all methods that run over time. You can start executing such methods using MethodInvoke(String, Object, Double, Double) method.
|
![]() | NetworkDisablePropertySynchronization | |
![]() | NetworkIsDisabledPropertySynchronization | |
![]() | NetworkModeAddUser | |
![]() | NetworkModeIsEnabledForUser | |
![]() | NetworkModeRemoveUser | |
![]() | NetworkRestoreDisabledPropertySynchronization | |
![]() | NewObjectSetDefaultConfiguration |
Called when the object is created in the editor. Designed to configure the initial state.
|
![]() | NewObjectSetDefaultConfigurationUpdate |
Called during object creation in the editor. Designed to configure the initial state.
|
![]() | OnAddedToParent |
Called when a component is added to the parent.
|
![]() | OnClientConnectedAfterRootComponentEnabled | |
![]() | OnClientConnectedBeforeRootComponentEnabled | |
![]() | OnClientDisconnected | |
![]() | OnClone |
Called when the object is cloned.
|
![]() | OnComponentAdded |
Called when a child component is added.
|
![]() | OnComponentRemoved |
Called when a child component is removed.
|
![]() | OnDisabled |
Called when the object is detached from a hierarchy of the components or is disabled. See also EnabledInHierarchy property.
|
![]() | OnDisabledInSimulation |
Called when the object is detached from a hierarchy of the components or is disabled. The method is called only in simulation application. See also EnabledInHierarchy property.
|
![]() | OnDispose |
Called when the object is disposed.
|
![]() | OnEditorGetTextInfoCenterBottomCorner | |
![]() | OnEnabled |
Called when the object is attached to a hierarchy of the components and is enabled. See also EnabledInHierarchy property.
|
![]() | OnEnabledChanged |
Called when value of Enabled property is changed.
|
![]() | OnEnabledInHierarchyChanged |
Called when value of EnabledInHierarchy property is changed.
|
![]() | OnEnabledInSimulation |
Called when the object is attached to a hierarchy of the components and is enabled. The method is called only in simulation application. See also EnabledInHierarchy property.
|
![]() | OnLoad |
Called during object loading.
|
![]() | OnMetadataGetMemberBySignature |
Called when the object metadata member is received by name.
|
![]() | OnMetadataGetMembers |
Called upon receipt of the object's metadata members.
|
![]() | OnMetadataGetMembersFilter |
Called when filtering receive members of the object metadata.
|
![]() | OnPreloadResources |
Called when preloading the resources used by the object.
|
![]() | OnReceiveNetworkMessageFromClient | |
![]() | OnReceiveNetworkMessageFromServer | |
![]() | OnRemovedFromParent |
Called when a component is removed from the parent.
|
![]() | OnSave |
Called during object saving.
|
![]() | OnSimulationStep |
Called during the simulation step.
|
![]() | OnSimulationStepClient |
Called during the simulation step.
|
![]() | OnUpdate |
Called during the update process of all objects.
|
![]() | PreloadResources |
Preload resources used by the object.
|
![]() ![]() |
Calls Info(Object).
| |
![]() | PropertyGet(String, Object, Boolean) |
Gets the value of a property by name.
|
![]() | PropertyGetT(String, Object, Boolean) |
Gets the value of a property by name.
|
![]() | PropertySet |
Sets the value of a property by name.
|
![]() | RemoveAllComponents |
Removes all child components.
|
![]() | RemoveComponent |
Removes a child component.
|
![]() | RemoveFromParent |
Detaches the object from its parent.
|
![]() | ToString |
Returns the name and type of the object as a string.
(Overrides ObjectToString.) |
![]() | TypeSettingsIsPublic |
Checks whether the object provided as a type is public.
|
![]() | TypeSettingsIsPublicMember |
Checks whether the member is set up as public.
|
Name | Description | |
---|---|---|
![]() | AddedToParent |
Occurs when a component is added to the parent.
|
![]() | CloneEvent |
Occurs when object is cloned.
|
![]() | CloneSupportChanged |
Occurs after changing value of CloneSupport property.
|
![]() | ComponentAdded |
Occurs when a child component is added.
|
![]() | ComponentRemoved |
Occurs when a child component is removed.
|
![]() | ComponentsChanged |
Occurs when the set of children is changed.
|
![]() | DisabledEvent |
Occurs when the object is disabled from a hierarchy of the components or is disabled. See also EnabledInHierarchy property.
|
![]() | DisabledInSimulation |
Occurs when the object is detached from a hierarchy of the components or is disabled. The method is called only in simulation application. See also EnabledInHierarchy property.
|
![]() | DisplayInEditorChanged |
Occurs when value of DisplayInEditor property is changed.
|
![]() | DisposeEvent |
Occurs when the object is disposed.
|
![]() | EnabledChanged |
Occurs when the Enabled property value changes.
|
![]() | EnabledEvent |
Occurs when the object is attached to a hierarchy of the components and is enabled. See also EnabledInHierarchy property.
|
![]() | EnabledInHierarchyChanged |
Occurs when the EnabledInHierarchy property value changes.
|
![]() | EnabledInSimulation |
Occurs when the object is attached to a hierarchy of the components and is enabled. The method is called only in simulation application. See also EnabledInHierarchy property.
|
![]() | LoadEvent |
Occurs during object loading.
|
![]() | MetadataGetMemberBySignatureEvent |
Occurs when the object metadata member is received by name.
|
![]() | MetadataGetMembersEvent |
Occurs upon receipt of the object's metadata members.
|
![]() | MetadataGetMembersFilterEvent |
Occurs when filtering receive members of the object metadata.
|
![]() | NameChanged |
Occurs when component name is changed.
|
![]() | NetworkModeChanged | Occurs when the NetworkMode property value changes. |
![]() | PreloadResourcesEvent |
Occurs when preloading the resources used by the object.
|
![]() | ReceiveNetworkMessageFromClient | |
![]() | ReceiveNetworkMessageFromServer | |
![]() | RemovedFromParent |
Occurs when a component is removed from the parent.
|
![]() | SaveEvent |
Occurs during object saving.
|
![]() | SaveSupportChanged |
Occurs after changing value of SaveSupport property.
|
![]() | ScreenLabelChanged | Occurs when the ScreenLabel property value changes. |
![]() | SimulationStep |
Occurs during the simulation step.
|
![]() | SimulationStepClient |
Occurs during the simulation step.
|
![]() | UpdateEvent |
Occurs during the update process of all objects.
|
Name | Description | |
---|---|---|
![]() | MethodInvoke |
Calls the object method by name.
(Defined by ObjectEx.) |
![]() | PropertyGet(String, Object, Boolean) | Overloaded.
Gets the value of the object property by name.
(Defined by ObjectEx.) |
![]() | PropertyGetT(String, Object, Boolean) | Overloaded.
Gets the value of the object property by name.
(Defined by ObjectEx.) |
![]() | PropertySet |
Sets the value of the object property by name.
(Defined by ObjectEx.) |