Click or drag to resize

Component Class

Base class of all components.
Inheritance Hierarchy
SystemObject
  NeoAxisComponent
    More...

Namespace:  NeoAxis
Assembly:  NeoAxis.Core (in NeoAxis.Core.dll) Version: 2021.3.1.0 (2021.3.1.0)
Syntax
C#
public class Component : MetadataIMetadataProvider, IDisposable

The Component type exposes the following members.

Constructors
  NameDescription
Public methodComponent
Initializes a new instance of the Component class
Top
Properties
  NameDescription
Public propertyAnyData
The user data of the component.
Public propertyBaseType
Gets the base type of the object.
Public propertyCloneSupport
Whether the object supports cloning.
Public propertyComponents
Gets the collection of the child components.
Public propertyCreatedByBaseType
Whether the object is created using a base type.
Public propertyDisplayInEditor
Whether to show the object in the editor.
Public propertyDisposed
Whether the object is disposed.
Public propertyEditorDocumentConfiguration
Gets or sets the configuration data of the object's settings in the editor.
Public propertyEditorReadOnly
Whether the object is read only in the editor.
Public propertyEditorReadOnlyInHierarchy
Whether the object is read-only in the editor with respect to parent objects.
Public propertyEnabled
Whether the component is enabled. See also EnabledInHierarchy property.
Public propertyEnabledInHierarchy
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.
Public propertyEnabledInHierarchyAndIsNotResource
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.
Public propertyHierarchyController
Gets the object hierarchy control controller.
Public propertyName
The name of the component.
Public propertyParent
Gets the parent object.
Public propertyParentRoot
Gets the parent root object.
Public propertyRemoveFromParentQueued
Whether the object is placed in the detach queue from the parent.
Public propertySaveSupport
Whether the object supports saving to a file.
Public propertyScreenLabel
Sets the display of the on-screen label of the object in the scene editor.
Public propertyTypeSettingsPrivateObjects
Object settings when used as a type.
Top
Methods
  NameDescription
Public methodAddComponent
Adds a component as a child.
Public methodClone
Creates a copy of the object.
Public methodCreateComponent(Type, Int32, Boolean, Boolean)
Creates a child component.
Public methodCreateComponent(MetadataTypeInfo, Int32, Boolean, Boolean)
Creates a child component.
Public methodCreateComponentT(Int32, Boolean, Boolean)
Creates a child component.
Public methodDispose
Detaches the object from the hierarchy and deletes the object data.
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodFindParent(Type)
Finds the parent of the specified type.
Public methodFindParent(MetadataTypeInfo)
Finds the parent of the specified type.
Public methodFindParentT
Finds the parent of the specified type.
Public methodFindThisOrParent(Type)
Finds the parent or self of the specified type.
Public methodFindThisOrParent(MetadataTypeInfo)
Finds the parent or self of the specified type.
Public methodFindThisOrParentT
Finds the parent or self of the specified type.
Public methodGetAllParents
Gets all parents of the component.
Public methodGetComponent(String, Boolean)
Finds a child component by name.
Public methodGetComponent(Type, Boolean, Boolean)
Finds a child component of the specified type.
Public methodGetComponent(MetadataTypeInfo, Boolean, Boolean)
Finds a child component of the specified type.
Public methodGetComponentT(Boolean, Boolean)
Finds a child component of the specified type.
Public methodGetComponentT(String, Boolean)
Finds a child component by name with the specified type.
Public methodGetComponentByNameWithIndex
Finds a child component by name and number in the case when there are several components with the specified name.
Public methodGetComponentByPath
Finds a child component by path.
Public methodGetComponents(Boolean, Boolean, Boolean, Boolean)
Finds child components.
Public methodGetComponents(Boolean, Boolean, Boolean, Boolean, ActionComponent)
Finds child components.
Public methodGetComponents(Type, Boolean, Boolean, Boolean, Boolean)
Finds child components of the specified type.
Public methodGetComponents(MetadataTypeInfo, Boolean, Boolean, Boolean, Boolean)
Finds child components of the specified type.
Public methodGetComponentsT(Boolean, Boolean, Boolean, Boolean)
Finds child components of the specified type.
Public methodGetComponentsT(Boolean, Boolean, Boolean, Boolean, ActionT)
Finds child components of the specified type.
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetPathFromParent
Returns the path to the object from the parent.
Public methodGetPathFromRoot
Returns the object's access path from the root object.
Public methodGetProvidedType
Returns a type when the object is used as a type.
Public methodGetScreenLabelInfo
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIsMethodInvoking
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodMetadataGetMemberBySignature
Returns the object metadata member by name.
Public methodMetadataGetMembers
Returns the object metadata members.
Public methodMethodInvoke
Calls a method by name.
Public methodMethodInvokeCancel
Public methodMethodInvokeCancelAll
Public methodNewObjectSetDefaultConfiguration
Called when the object is created in the editor. Designed to configure the initial state.
Public methodNewObjectSetDefaultConfigurationUpdate
Called during object creation in the editor. Designed to configure the initial state.
Protected methodOnAddedToParent
Called when a component is added to the parent.
Protected methodOnClone
Called when the object is cloned.
Protected methodOnComponentAdded
Called when a child component is added.
Protected methodOnComponentRemoved
Called when a child component is removed.
Protected methodOnDisabled
Called when the object is detached from a hierarchy of the components or is disabled. See also EnabledInHierarchy property.
Protected methodOnDisabledInSimulation
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.
Protected methodOnDispose
Called when the object is disposed.
Protected methodOnEditorGetTextInfoCenterBottomCorner
Protected methodOnEnabled
Called when the object is attached to a hierarchy of the components and is enabled. See also EnabledInHierarchy property.
Protected methodOnEnabledChanged
Called when value of Enabled property is changed.
Protected methodOnEnabledInHierarchyChanged
Called when value of EnabledInHierarchy property is changed.
Protected methodOnEnabledInSimulation
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.
Protected methodOnLoad
Called during object loading.
Protected methodOnMetadataGetMemberBySignature
Called when the object metadata member is received by name.
Protected methodOnMetadataGetMembers
Called upon receipt of the object's metadata members.
Protected methodOnMetadataGetMembersFilter
Called when filtering receive members of the object metadata.
Protected methodOnPreloadResources
Called when preloading the resources used by the object.
Protected methodOnRemovedFromParent
Called when a component is removed from the parent.
Protected methodOnSave
Called during object saving.
Protected methodOnSimulationStep
Called during the simulation step.
Protected methodOnUpdate
Called during the update process of all objects.
Public methodPreloadResources
Preload resources used by the object.
Public methodStatic memberPrint
Calls Info(Object).
Public methodPropertyGet(String, Object, Boolean)
Gets the value of a property by name.
Public methodPropertyGetT(String, Object, Boolean)
Gets the value of a property by name.
Public methodPropertySet
Sets the value of a property by name.
Public methodRemoveAllComponents
Removes all child components.
Public methodRemoveComponent
Removes a child component.
Public methodRemoveFromParent
Detaches the object from its parent.
Public methodToString
Returns the name and type of the object as a string.
(Overrides ObjectToString.)
Public methodTypeSettingsIsPublic
Checks whether the object provided as a type is public.
Public methodTypeSettingsIsPublicMember
Checks whether the member is set up as public.
Top
Events
  NameDescription
Public eventAddedToParent
Occurs when a component is added to the parent.
Public eventCloneEvent
Occurs when object is cloned.
Public eventCloneSupportChanged
Occurs after changing value of CloneSupport property.
Public eventComponentAdded
Occurs when a child component is added.
Public eventComponentRemoved
Occurs when a child component is removed.
Public eventComponentsChanged
Occurs when the set of children is changed.
Public eventDisabledEvent
Occurs when the object is disabled from a hierarchy of the components or is disabled. See also EnabledInHierarchy property.
Public eventDisabledInSimulation
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.
Public eventDisplayInEditorChanged
Occurs when value of DisplayInEditor property is changed.
Public eventDisposeEvent
Occurs when the object is disposed.
Public eventEnabledChanged
Occurs when the Enabled property value changes.
Public eventEnabledEvent
Occurs when the object is attached to a hierarchy of the components and is enabled. See also EnabledInHierarchy property.
Public eventEnabledInHierarchyChanged
Occurs when the EnabledInHierarchy property value changes.
Public eventEnabledInSimulation
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.
Public eventLoadEvent
Occurs during object loading.
Public eventMetadataGetMemberBySignatureEvent
Occurs when the object metadata member is received by name.
Public eventMetadataGetMembersEvent
Occurs upon receipt of the object's metadata members.
Public eventMetadataGetMembersFilterEvent
Occurs when filtering receive members of the object metadata.
Public eventNameChanged
Occurs when component name is changed.
Public eventPreloadResourcesEvent
Occurs when preloading the resources used by the object.
Public eventRemovedFromParent
Occurs when a component is removed from the parent.
Public eventSaveEvent
Occurs during object saving.
Public eventSaveSupportChanged
Occurs after changing value of SaveSupport property.
Public eventScreenLabelChanged
Occurs when the ScreenLabel property value changes.
Public eventSimulationStep
Occurs during the simulation step.
Public eventUpdateEvent
Occurs during the update process of all objects.
Top
Extension Methods
See Also
Inheritance Hierarchy
SystemObject
  NeoAxisComponent
    NeoAxisComponent_AI
    NeoAxisComponent_AITask
    NeoAxisComponent_Animation
    NeoAxisComponent_AnimationTriggerPoint
    NeoAxisComponent_CameraManagement
    NeoAxisComponent_CollisionShape
    NeoAxisComponent_CollisionShape2D
    NeoAxisComponent_ComponentHost
    NeoAxisComponent_ComputeUsingThreads
    NeoAxisComponent_ConvertTo
    NeoAxisComponent_CSharpScript
    NeoAxisComponent_DeclareVariable
    NeoAxisComponent_DoNumber
    NeoAxisComponent_DoWhile
    NeoAxisComponent_EventHandler
    NeoAxisComponent_FlowGraph
    NeoAxisComponent_FlowGraphNode
    NeoAxisComponent_FlowGraphNodeStyle
    NeoAxisComponent_FlowGraphSpecialization
    NeoAxisComponent_FlowGraphStyle
    NeoAxisComponent_FlowStart
    NeoAxisComponent_Fog
    NeoAxisComponent_Font
    NeoAxisComponent_For
    NeoAxisComponent_ForEach
    NeoAxisComponent_GameMode
    NeoAxisComponent_GroupOfObjects
    NeoAxisComponent_GroupOfObjectsElement
    NeoAxisComponent_If
    NeoAxisComponent_Import3D
    NeoAxisComponent_InputProcessing
    NeoAxisComponent_InvokeMember
    NeoAxisComponent_Layer
    NeoAxisComponent_Learning
    NeoAxisComponent_LensFlare
    NeoAxisComponent_LensFlares
    NeoAxisComponent_Member
    NeoAxisComponent_MemberParameter
    NeoAxisComponent_MeshGeometry
    NeoAxisComponent_MeshInSpaceAnimationController
    NeoAxisComponent_MeshLevelOfDetail
    NeoAxisComponent_MeshModifier
    NeoAxisComponent_MethodBody
    NeoAxisComponent_MethodBodyEnd
    NeoAxisComponent_ObjectInSpace
    NeoAxisComponent_PaintLayer
    NeoAxisComponent_ParticleEmitter
    NeoAxisComponent_ParticleModule
    NeoAxisComponent_Pathfinding_GeometryTag
    NeoAxisComponent_PhysicalMaterial
    NeoAxisComponent_Product
    NeoAxisComponent_ProjectSettings
    NeoAxisComponent_ProjectSettings_Page
    NeoAxisComponent_RenderingPipeline
    NeoAxisComponent_RenderToFile
    NeoAxisComponent_ResultCompileT
    NeoAxisComponent_Scene
    NeoAxisComponent_Sequence
    NeoAxisComponent_SetVariable
    NeoAxisComponent_ShaderParameter
    NeoAxisComponent_ShaderScript
    NeoAxisComponent_ShaderTextureSample
    NeoAxisComponent_Skeleton
    NeoAxisComponent_SkeletonAnimationTrack
    NeoAxisComponent_SkeletonBone
    NeoAxisComponent_Sky
    NeoAxisComponent_Sleep
    NeoAxisComponent_SpriteAnimationController
    NeoAxisComponent_SpriteAnimationFrame
    NeoAxisComponent_StoreProduct
    NeoAxisComponent_Surface
    NeoAxisComponent_SurfaceElement
    NeoAxisComponent_SurfaceGroupOfElements
    NeoAxisComponent_SurfaceLayer
    NeoAxisComponent_Switch
    NeoAxisComponent_Terrain
    NeoAxisComponent_TransformOffset
    NeoAxisComponent_While
    NeoAxisComponent_WorldGenerator
    NeoAxisShaderGeneratorPaintLayerOpacityPropertyWithMask
    NeoAxisUIControl
    NeoAxisUIStyle
    NeoAxisUITooltip