Click or drag to resize

Component_Sensor Class

The event trigger in the scene. The sensor allows you to select scene objects by a given volume or ray.
Inheritance Hierarchy

Namespace:  NeoAxis
Assembly:  NeoAxis.Core (in NeoAxis.Core.dll) Version: 2021.3.1.0 (2021.3.1.0)
Syntax
C#
public class Component_Sensor : Component_ObjectInSpace

The Component_Sensor type exposes the following members.

Constructors
  NameDescription
Public methodComponent_Sensor
Initializes a new instance of the Component_Sensor class
Top
Properties
  NameDescription
Public propertyAnyData
The user data of the component.
(Inherited from Component.)
Public propertyBaseType
Gets the base type of the object.
(Inherited from Component.)
Public propertyCanBeSelected
Whether the object is selectable in the scene view.
(Inherited from Component_ObjectInSpace.)
Public propertyCanBeSelectedInHierarchy (Inherited from Component_ObjectInSpace.)
Public propertyCloneSupport
Whether the object supports cloning.
(Inherited from Component.)
Public propertyComponents
Gets the collection of the child components.
(Inherited from Component.)
Public propertyConvexSweepTarget
The end point of the sensor in Convex Sweep mode.
Public propertyCreatedByBaseType
Whether the object is created using a base type.
(Inherited from Component.)
Public propertyDisplayColor
The display color of the sensor.
Public propertyDisplayInEditor
Whether to show the object in the editor.
(Inherited from Component.)
Public propertyDisplayObjects
Whether to draw gizmos on the objects recognized by the sensor.
Public propertyDisplayObjectsColor
The color of the recognized object gizmos.
Public propertyDisposed
Whether the object is disposed.
(Inherited from Component.)
Public propertyEditorDocumentConfiguration
Gets or sets the configuration data of the object's settings in the editor.
(Inherited from Component.)
Public propertyEditorReadOnly
Whether the object is read only in the editor.
(Inherited from Component.)
Public propertyEditorReadOnlyInHierarchy
Whether the object is read-only in the editor with respect to parent objects.
(Inherited from Component.)
Public propertyEnabled
Whether the component is enabled. See also EnabledInHierarchy property.
(Inherited from Component.)
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.
(Inherited from Component.)
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.
(Inherited from Component.)
Public propertyEnabledSelectionByCursor (Inherited from Component_ObjectInSpace.)
Public propertyFilterByType
The type of objects that sensor will recognize.
Public propertyHierarchyController
Gets the object hierarchy control controller.
(Inherited from Component.)
Public propertyIgnoreSensors
Whether the sensor is ignoring other sensors.
Public propertyMode
The recognition mode of the sensor.
Public propertyName
The name of the component.
(Inherited from Component.)
Public propertyObjects
List of objects recognized by the sensor.
Public propertyParent
Gets the parent object.
(Inherited from Component.)
Public propertyParentRoot
Gets the parent root object.
(Inherited from Component.)
Public propertyParentScene (Inherited from Component_ObjectInSpace.)
Public propertyPhysicsFilterGroup
The group of physical objects that sensor will recognize.
Public propertyPhysicsFilterMask
The mask of physical objects that sensor will recognize.
Public propertyRayTarget
The target by which the sensor ray will trigger.
Public propertyRemoveFromParentQueued
Whether the object is placed in the detach queue from the parent.
(Inherited from Component.)
Public propertySaveSupport
Whether the object supports saving to a file.
(Inherited from Component.)
Public propertyScreenLabel
Sets the display of the on-screen label of the object in the scene editor.
(Inherited from Component.)
Public propertyShape
The shape of the trigger.
Public propertySourceData
What kind of data is used as a source of events.
Public propertySpaceBounds (Inherited from Component_ObjectInSpace.)
Public propertySpaceBoundsOverride (Inherited from Component_ObjectInSpace.)
Public propertyTransform
The position, rotation and scale of the object.
(Inherited from Component_ObjectInSpace.)
Public propertyTransformV
Simplier form of Transform.Value.
(Inherited from Component_ObjectInSpace.)
Public propertyTypeSettingsPrivateObjects
Object settings when used as a type.
(Inherited from Component.)
Public propertyVisible
Whether the object is visible in the scene.
(Inherited from Component_ObjectInSpace.)
Public propertyVisibleInHierarchy (Inherited from Component_ObjectInSpace.)
Public propertyWhenUpdate
The update case mode of the sensor.
Top
Methods
  NameDescription
Public methodAddComponent
Adds a component as a child.
(Inherited from Component.)
Public methodCalculateObjects
Public methodCheckSelectionByRay (Inherited from Component_ObjectInSpace.)
Public methodClone
Creates a copy of the object.
(Inherited from Component.)
Public methodCreateComponent(Type, Int32, Boolean, Boolean)
Creates a child component.
(Inherited from Component.)
Public methodCreateComponent(MetadataTypeInfo, Int32, Boolean, Boolean)
Creates a child component.
(Inherited from Component.)
Public methodCreateComponentT(Int32, Boolean, Boolean)
Creates a child component.
(Inherited from Component.)
Public methodDispose
Detaches the object from the hierarchy and deletes the object data.
(Inherited from Component.)
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.
(Inherited from Component.)
Public methodFindParent(MetadataTypeInfo)
Finds the parent of the specified type.
(Inherited from Component.)
Public methodFindParentT
Finds the parent of the specified type.
(Inherited from Component.)
Public methodFindThisOrParent(Type)
Finds the parent or self of the specified type.
(Inherited from Component.)
Public methodFindThisOrParent(MetadataTypeInfo)
Finds the parent or self of the specified type.
(Inherited from Component.)
Public methodFindThisOrParentT
Finds the parent or self of the specified type.
(Inherited from Component.)
Public methodGetAllParents
Gets all parents of the component.
(Inherited from Component.)
Public methodGetBox
Public methodGetComponent(String, Boolean)
Finds a child component by name.
(Inherited from Component.)
Public methodGetComponent(Type, Boolean, Boolean)
Finds a child component of the specified type.
(Inherited from Component.)
Public methodGetComponent(MetadataTypeInfo, Boolean, Boolean)
Finds a child component of the specified type.
(Inherited from Component.)
Public methodGetComponentT(Boolean, Boolean)
Finds a child component of the specified type.
(Inherited from Component.)
Public methodGetComponentByNameWithIndex
Finds a child component by name and number in the case when there are several components with the specified name.
(Inherited from Component.)
Public methodGetComponentByPath
Finds a child component by path.
(Inherited from Component.)
Public methodGetComponents(Boolean, Boolean, Boolean, Boolean)
Finds child components.
(Inherited from Component.)
Public methodGetComponents(Boolean, Boolean, Boolean, Boolean, ActionComponent)
Finds child components.
(Inherited from Component.)
Public methodGetComponents(Type, Boolean, Boolean, Boolean, Boolean)
Finds child components of the specified type.
(Inherited from Component.)
Public methodGetComponents(MetadataTypeInfo, Boolean, Boolean, Boolean, Boolean)
Finds child components of the specified type.
(Inherited from Component.)
Public methodGetComponentsT(Boolean, Boolean, Boolean, Boolean, ActionT)
Finds child components of the specified type.
(Inherited from Component.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetPathFromParent
Returns the path to the object from the parent.
(Inherited from Component.)
Public methodGetPathFromRoot
Returns the object's access path from the root object.
(Inherited from Component.)
Public methodGetProvidedType
Returns a type when the object is used as a type.
(Inherited from Component.)
Public methodGetRay
Public methodGetScreenLabelInfo (Overrides ComponentGetScreenLabelInfo.)
Public methodGetSphere
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIsMethodInvoking (Inherited from Component.)
Public methodLookAt(Component_ObjectInSpace) (Inherited from Component_ObjectInSpace.)
Public methodLookAt(Vector3) (Inherited from Component_ObjectInSpace.)
Public methodLookAt(Component_ObjectInSpace, Vector3) (Inherited from Component_ObjectInSpace.)
Public methodLookAt(Vector3, Vector3) (Inherited from Component_ObjectInSpace.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodMetadataGetMemberBySignature
Returns the object metadata member by name.
(Inherited from Component.)
Public methodMetadataGetMembers
Returns the object metadata members.
(Inherited from Component.)
Public methodMethodInvoke
Calls a method by name.
(Inherited from Component.)
Public methodMethodInvokeCancel (Inherited from Component.)
Public methodMethodInvokeCancelAll (Inherited from Component.)
Public methodNewObjectSetDefaultConfiguration
Called when the object is created in the editor. Designed to configure the initial state.
(Inherited from Component.)
Public methodNewObjectSetDefaultConfigurationUpdate
Called during object creation in the editor. Designed to configure the initial state.
(Inherited from Component.)
Protected methodOnAddedToParent
Called when a component is added to the parent.
(Inherited from Component.)
Protected methodOnCalculateObjects
Protected methodOnCheckSelectionByRay (Inherited from Component_ObjectInSpace.)
Protected methodOnClone
Called when the object is cloned.
(Inherited from Component.)
Protected methodOnComponentAdded
Called when a child component is added.
(Inherited from Component.)
Protected methodOnComponentRemoved
Called when a child component is removed.
(Inherited from Component.)
Protected methodOnDisabled
Called when the object is detached from a hierarchy of the components or is disabled. See also EnabledInHierarchy property.
(Inherited from Component.)
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.
(Inherited from Component.)
Protected methodOnDispose
Called when the object is disposed.
(Inherited from Component.)
Protected methodOnEditorGetTextInfoCenterBottomCorner (Inherited from Component.)
Protected methodOnEnabled
Called when the object is attached to a hierarchy of the components and is enabled. See also EnabledInHierarchy property.
(Inherited from Component.)
Protected methodOnEnabledChanged
Called when value of Enabled property is changed.
(Inherited from Component.)
Protected methodOnEnabledInHierarchyChanged (Overrides Component_ObjectInSpaceOnEnabledInHierarchyChanged.)
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.
(Inherited from Component.)
Protected methodOnEnabledSelectionByCursor (Inherited from Component_ObjectInSpace.)
Protected methodOnFilterObject
Public methodOnGetRenderSceneData (Overrides Component_ObjectInSpaceOnGetRenderSceneData(ViewportRenderingContext, GetRenderSceneDataMode, Component_SceneGetObjectsInSpaceItem).)
Protected methodOnLoad
Called during object loading.
(Inherited from Component.)
Protected methodOnMetadataGetMemberBySignature
Called when the object metadata member is received by name.
(Inherited from Component.)
Protected methodOnMetadataGetMembers
Called upon receipt of the object's metadata members.
(Inherited from Component.)
Protected methodOnMetadataGetMembersFilter (Overrides ComponentOnMetadataGetMembersFilter(MetadataGetMembersContext, MetadataMember, Boolean).)
Protected methodOnObjectEnter
Protected methodOnObjectLeave
Protected methodOnPreloadResources
Called when preloading the resources used by the object.
(Inherited from Component.)
Protected methodOnRemovedFromParent
Called when a component is removed from the parent.
(Inherited from Component.)
Protected methodOnSave
Called during object saving.
(Inherited from Component.)
Protected methodOnSimulationStep (Overrides ComponentOnSimulationStep.)
Protected methodOnSpaceBoundsChanged (Inherited from Component_ObjectInSpace.)
Protected methodOnSpaceBoundsUpdate (Overrides Component_ObjectInSpaceOnSpaceBoundsUpdate(SpaceBounds).)
Protected methodOnSpaceBoundsUpdateIncludeChildren (Inherited from Component_ObjectInSpace.)
Protected methodOnTransformChanged (Inherited from Component_ObjectInSpace.)
Protected methodOnTransformUpdating (Inherited from Component_ObjectInSpace.)
Protected methodOnUpdate (Overrides ComponentOnUpdate(Single).)
Public methodPerformFilterObject
Public methodPreloadResources
Preload resources used by the object.
(Inherited from Component.)
Public methodPropertyGet(String, Object, Boolean)
Gets the value of a property by name.
(Inherited from Component.)
Public methodPropertySet
Sets the value of a property by name.
(Inherited from Component.)
Public methodRemoveAllComponents
Removes all child components.
(Inherited from Component.)
Public methodRemoveComponent
Removes a child component.
(Inherited from Component.)
Public methodRemoveFromParent
Detaches the object from its parent.
(Inherited from Component.)
Protected methodRenderShape
Public methodSetPosition(Vector3) (Inherited from Component_ObjectInSpace.)
Public methodSetPosition(Double, Double, Double) (Inherited from Component_ObjectInSpace.)
Public methodSetRotation(Angles) (Inherited from Component_ObjectInSpace.)
Public methodSetRotation(Quaternion) (Inherited from Component_ObjectInSpace.)
Public methodSetRotation(Double, Double, Double) (Inherited from Component_ObjectInSpace.)
Public methodSetScale(Double) (Inherited from Component_ObjectInSpace.)
Public methodSetScale(Vector3) (Inherited from Component_ObjectInSpace.)
Public methodSetScale(Double, Double, Double) (Inherited from Component_ObjectInSpace.)
Public methodSpaceBoundsUpdate (Inherited from Component_ObjectInSpace.)
Public methodToString
Returns the name and type of the object as a string.
(Inherited from Component.)
Public methodTypeSettingsIsPublic
Checks whether the object provided as a type is public.
(Inherited from Component.)
Public methodTypeSettingsIsPublicMember
Checks whether the member is set up as public.
(Inherited from Component.)
Public methodUpdate
Top
Events
  NameDescription
Public eventAddedToParent
Occurs when a component is added to the parent.
(Inherited from Component.)
Public eventCalculateObjectsEvent
Public eventCanBeSelectedChanged
Occurs when the CanBeSelected property value changes.
(Inherited from Component_ObjectInSpace.)
Public eventCloneEvent
Occurs when object is cloned.
(Inherited from Component.)
Public eventCloneSupportChanged
Occurs after changing value of CloneSupport property.
(Inherited from Component.)
Public eventComponentAdded
Occurs when a child component is added.
(Inherited from Component.)
Public eventComponentRemoved
Occurs when a child component is removed.
(Inherited from Component.)
Public eventComponentsChanged
Occurs when the set of children is changed.
(Inherited from Component.)
Public eventConvexSweepTargetChanged
Occurs when the ConvexSweepTarget property value changes.
Public eventDisabledEvent
Occurs when the object is disabled from a hierarchy of the components or is disabled. See also EnabledInHierarchy property.
(Inherited from Component.)
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.
(Inherited from Component.)
Public eventDisplayColorChanged
Occurs when the DisplayColor property value changes.
Public eventDisplayInEditorChanged
Occurs when value of DisplayInEditor property is changed.
(Inherited from Component.)
Public eventDisplayObjectsChanged
Occurs when the DisplayObjects property value changes.
Public eventDisplayObjectsColorChanged
Occurs when the DisplayObjectsColor property value changes.
Public eventDisposeEvent
Occurs when the object is disposed.
(Inherited from Component.)
Public eventEnabledChanged
Occurs when the Enabled property value changes.
(Inherited from Component.)
Public eventEnabledEvent
Occurs when the object is attached to a hierarchy of the components and is enabled. See also EnabledInHierarchy property.
(Inherited from Component.)
Public eventEnabledInHierarchyChanged
Occurs when the EnabledInHierarchy property value changes.
(Inherited from Component.)
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.
(Inherited from Component.)
Public eventFilterByTypeChanged
Occurs when the FilterByType property value changes.
Public eventFilterObjectEvent
Public eventGetRenderSceneData (Inherited from Component_ObjectInSpace.)
Public eventGetRenderSceneDataBefore (Inherited from Component_ObjectInSpace.)
Public eventIgnoreSensorsChanged
Occurs when the IgnoreSensors property value changes.
Public eventLoadEvent
Occurs during object loading.
(Inherited from Component.)
Public eventMetadataGetMemberBySignatureEvent
Occurs when the object metadata member is received by name.
(Inherited from Component.)
Public eventMetadataGetMembersEvent
Occurs upon receipt of the object's metadata members.
(Inherited from Component.)
Public eventMetadataGetMembersFilterEvent
Occurs when filtering receive members of the object metadata.
(Inherited from Component.)
Public eventModeChanged
Occurs when the Mode property value changes.
Public eventNameChanged
Occurs when component name is changed.
(Inherited from Component.)
Public eventObjectEnter
Public eventObjectLeave
Public eventObjectsChanged
Public eventPhysicsFilterGroupChanged
Occurs when the PhysicsFilterGroup property value changes.
Public eventPhysicsFilterMaskChanged
Occurs when the PhysicsFilterMask property value changes.
Public eventPreloadResourcesEvent
Occurs when preloading the resources used by the object.
(Inherited from Component.)
Public eventRayTargetChanged
Occurs when the RayTarget property value changes.
Public eventRemovedFromParent
Occurs when a component is removed from the parent.
(Inherited from Component.)
Public eventSaveEvent
Occurs during object saving.
(Inherited from Component.)
Public eventSaveSupportChanged
Occurs after changing value of SaveSupport property.
(Inherited from Component.)
Public eventScreenLabelChanged
Occurs when the ScreenLabel property value changes.
(Inherited from Component.)
Public eventShapeChanged
Occurs when the Shape property value changes.
Public eventSimulationStep
Occurs during the simulation step.
(Inherited from Component.)
Public eventSourceDataChanged
Occurs when the SourceData property value changes.
Public eventSpaceBoundsChanged
Occurs when the SpaceBounds property value changes.
(Inherited from Component_ObjectInSpace.)
Public eventSpaceBoundsUpdateEvent (Inherited from Component_ObjectInSpace.)
Public eventSpaceBoundsUpdateIncludeChildrenEvent (Inherited from Component_ObjectInSpace.)
Public eventTransformChanged
Occurs when the Transform property value changes.
(Inherited from Component_ObjectInSpace.)
Public eventTransformUpdatingEvent (Inherited from Component_ObjectInSpace.)
Public eventUpdateEvent
Occurs during the update process of all objects.
(Inherited from Component.)
Public eventVisibleChanged
Occurs when the Visible property value changes.
(Inherited from Component_ObjectInSpace.)
Public eventWhenUpdateChanged
Occurs when the WhenUpdate property value changes.
Top
Extension Methods
See Also