Click or drag to resize

ProjectSettingsPage_General Class

Represents a General page of the project settings.
Inheritance Hierarchy

Namespace:  NeoAxis
Assembly:  NeoAxis.Core (in NeoAxis.Core.dll) Version: 2022.1.1.0 (2022.1.1.0)
Syntax
C#
public class ProjectSettingsPage_General : ProjectSettingsPage

The ProjectSettingsPage_General type exposes the following members.

Constructors
  NameDescription
Public methodProjectSettingsPage_General
Initializes a new instance of the ProjectSettingsPage_General class
Top
Properties
  NameDescription
Public propertyAnimateWindowsAutoHiding
Whether to animate windows auto-hiding in the editor.
Public propertyAnyData
The user data of the component.
(Inherited from Component.)
Public propertyAutorunScene
A scene to run automatically when the Player started.
Public propertyBaseType
Gets the base type of the object.
(Inherited from Component.)
Public propertyCanSelectColor
The color of selectable object in the scene view.
Public propertyCloneSupport
Whether the object supports cloning.
(Inherited from Component.)
Public propertyComponents
Gets the collection of the child components.
(Inherited from Component.)
Public propertyCreatedByBaseType
Whether the object is created using a base type.
(Inherited from Component.)
Public propertyCustomWindowsStyle
Whether to use custom style for window title bars. Windows only. Restart the editor to apply changes.
Public propertyDisplayHierarchyOfObjectsInSettingsWindow
Whether to enable an additional objects tree in the Settings window. This makes it possible to work with objects more flexibly, although it takes up more space in the window.
Public propertyDisplayInEditor
Whether to show the object in the editor.
(Inherited from Component.)
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 propertyExtendedMode
Enables the extended mode of the editor. All features of NeoAxis Editor are activated in this mode.
Public propertyHiddenByOtherObjectsColorMultiplier
The color multiplier applied when object is hidden by the other objects.
Public propertyHierarchyController
Gets the object hierarchy control controller.
(Inherited from Component.)
Public propertyInitialUIScreen
Initial UI file when starting the project application.
Public propertyLanguage
The language of the editor. Restart the editor to apply changes.
Public propertyMaterialPreviewEnvironmentAffectLighting
Public propertyMaterialPreviewEnvironmentDarkTheme
Public propertyMaterialPreviewEnvironmentLightTheme
Public propertyMaterialPreviewEnvironmentMultiplier
Public propertyMaterialPreviewMesh
Public propertyMaxFramesPerSecondDocument
The maximum FPS in the document.
Public propertyMaxFramesPerSecondPreview
The maximum FPS in the preview.
Public propertyName
The name of the component.
(Inherited from Component.)
Public propertyParent
Gets the parent object.
(Inherited from Component.)
Public propertyParentRoot
Gets the parent root object.
(Inherited from Component.)
Public propertyPreviewAmbientLightBrightness
Public propertyPreviewDirectionalLightBrightness
Public propertyProjectName
The name of the project.
Public propertyPropertiesMaxCountCollectionItemsToDisplay
The maximum number of items that can be displayed for collections in the Settings window.
Public propertyRemoveFromParentQueued
Whether the object is placed in the detach queue from the parent.
(Inherited from Component.)
Public propertyRunSimulationInFullscreen
Whether to launch the Player in fullscreen mode.
Public propertySaveSupport
Whether the object supports saving to a file.
(Inherited from Component.)
Public propertySceneShowAreaColor
The color of areas in the scene view.
Public propertySceneShowDecalColor
The color of decals in the scene view.
Public propertySceneShowLightColor
The color of light source objects in the scene view.
Public propertySceneShowObjectInSpaceBoundsColor
The color of abstract objects in the scene view.
Public propertySceneShowPhysicsDynamicActiveColor
The color of active dynamic physics objects in the scene view.
Public propertySceneShowPhysicsDynamicInactiveColor
The color of inactive dynamic physics objects in the scene view.
Public propertySceneShowPhysicsStaticColor
The color of static physics objects in the scene view.
Public propertySceneShowReflectionProbeColor
The color of reflection probe objects in the scene view.
Public propertySceneShowSoundSourceColor
The color of sound source objects in the scene view.
Public propertySceneShowVolumeColor
The color of volumes in the scene view.
Public propertyScreenLabel
Sets the display of the on-screen label of the object in the scene editor.
(Inherited from Component.)
Public propertyScreenLabelColor
The color of screen labels.
Public propertyScreenLabelDisplayIcons
Public propertyScreenLabelMaxDistance
Public propertyScreenLabelMaxSize
Public propertyScreenLabelMinSizeFactor
Public propertySelectedColor
The color of selected object in the scene view.
Public propertyShowCenteringBorders
Whether to show centering borders for Mesh and Surface editors to help take screenshots for the store.
Public propertySimulationStepsPerSecond
The number of simulation steps per second.
Public propertySimulationStepsPerSecondInv
Public propertySoundVolume
The volume of the sound playback.
Public propertySplashScreenAtStartup
Shows the splash screen at start-up of the editor.
Public propertyTheme
The theme of the editor. Restart the editor to apply changes.
Public propertyTypeSettingsPrivateObjects
Object settings when used as a type.
(Inherited from Component.)
Public propertyUserMode (Inherited from ProjectSettingsPage.)
Public propertyWindowSize
The initial window size of the project window for Normal window state.
Public propertyWindowState
The initial state of the project window. When set to Auto, it will enabled Fullscreen mode or Maximized mode when run from the editor.
Top
Methods
  NameDescription
Public methodAddComponent
Adds a component as a child.
(Inherited from Component.)
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 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 methodGetMaterialPreviewEnvironment
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 methodGetScreenLabelInfo (Inherited from Component.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIsMethodInvoking (Inherited from Component.)
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 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
Called when value of EnabledInHierarchy property is changed.
(Inherited from Component.)
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 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 ProjectSettingsPageOnMetadataGetMembersFilter(MetadataGetMembersContext, MetadataMember, Boolean).)
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
Called during the simulation step.
(Inherited from Component.)
Protected methodOnUpdate
Called during the update process of all objects.
(Inherited from Component.)
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.)
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.)
Top
Events
  NameDescription
Public eventAddedToParent
Occurs when a component is added to the parent.
(Inherited from Component.)
Public eventAnimateAutoHideWindowsChanged
Occurs when the AnimateWindowsAutoHiding property value changes.
Public eventAutorunSceneChanged
Occurs when the AutorunScene property value changes.
Public eventCanSelectColorChanged
Occurs when the CanSelectColor property value changes.
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 eventCustomWindowsStyleChanged
Occurs when the CustomWindowsStyle 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 eventDisplayHierarchyOfObjectsInSettingsWindowChanged
Occurs when the DisplayHierarchyOfObjectsInSettingsWindow property value changes.
Public eventDisplayInEditorChanged
Occurs when value of DisplayInEditor property is changed.
(Inherited from Component.)
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 eventExtendedModeChanged
Occurs when the ExtendedMode property value changes.
Public eventHiddenByOtherObjectsColorMultiplierChanged
Occurs when the HiddenByOtherObjectsColorMultiplier property value changes.
Public eventInitialUIScreenChanged
Occurs when the InitialUIScreen property value changes.
Public eventLanguageChanged
Occurs when the Language property value changes.
Public eventLoadEvent
Occurs during object loading.
(Inherited from Component.)
Public eventMaterialPreviewEnvironmentAffectLightingChanged
Occurs when the MaterialPreviewEnvironmentAffectLighting property value changes.
Public eventMaterialPreviewEnvironmentDarkThemeChanged
Occurs when the MaterialPreviewEnvironmentDarkTheme property value changes.
Public eventMaterialPreviewEnvironmentLightThemeChanged
Occurs when the MaterialPreviewEnvironmentLightTheme property value changes.
Public eventMaterialPreviewEnvironmentMultiplierChanged
Occurs when the MaterialPreviewEnvironmentMultiplier property value changes.
Public eventMaterialPreviewMeshChanged
Occurs when the MaterialPreviewMesh property value changes.
Public eventMaxFramesPerSecondDocumentChanged
Occurs when the MaxFramesPerSecondDocument property value changes.
Public eventMaxFramesPerSecondPreviewChanged
Occurs when the MaxFramesPerSecondPreview property value changes.
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 eventNameChanged
Occurs when component name is changed.
(Inherited from Component.)
Public eventPreloadResourcesEvent
Occurs when preloading the resources used by the object.
(Inherited from Component.)
Public eventPreviewAmbientLightBrightnessChanged
Occurs when the PreviewAmbientLightBrightness property value changes.
Public eventPreviewDirectionalLightBrightnessChanged
Occurs when the PreviewDirectionalLightBrightness property value changes.
Public eventProjectNameChanged
Occurs when the ProjectName property value changes.
Public eventPropertiesMaxCountCollectionItemsToDisplayChanged
Occurs when the PropertiesMaxCountCollectionItemsToDisplay property value changes.
Public eventRemovedFromParent
Occurs when a component is removed from the parent.
(Inherited from Component.)
Public eventRunSimulationInFullscreenChanged
Occurs when the RunSimulationInFullscreen property value changes.
Public eventSaveEvent
Occurs during object saving.
(Inherited from Component.)
Public eventSaveSupportChanged
Occurs after changing value of SaveSupport property.
(Inherited from Component.)
Public eventSceneShowAreaColorChanged
Occurs when the SceneShowAreaColor property value changes.
Public eventSceneShowDecalColorChanged
Occurs when the SceneShowDecalColor property value changes.
Public eventSceneShowLightColorChanged
Occurs when the SceneShowLightColor property value changes.
Public eventSceneShowObjectInSpaceBoundsColorChanged
Occurs when the SceneShowObjectInSpaceBoundsColor property value changes.
Public eventSceneShowPhysicsDynamicActiveColorChanged
Occurs when the SceneShowPhysicsDynamicActiveColor property value changes.
Public eventSceneShowPhysicsDynamicInactiveColorChanged
Occurs when the SceneShowPhysicsDynamicInactiveColor property value changes.
Public eventSceneShowPhysicsStaticColorChanged
Occurs when the SceneShowPhysicsStaticColor property value changes.
Public eventSceneShowReflectionProbeColorChanged
Occurs when the SceneShowReflectionProbeColor property value changes.
Public eventSceneShowSoundSourceColorChanged
Occurs when the SceneShowSoundSourceColor property value changes.
Public eventSceneShowVolumeColorChanged
Occurs when the SceneShowVolumeColor property value changes.
Public eventScreenLabelChanged
Occurs when the ScreenLabel property value changes.
(Inherited from Component.)
Public eventScreenLabelColorChanged
Occurs when the ScreenLabelColor property value changes.
Public eventScreenLabelDisplayIconsChanged
Occurs when the ScreenLabelDisplayIcons property value changes.
Public eventScreenLabelMaxDistanceChanged
Occurs when the ScreenLabelMaxDistance property value changes.
Public eventScreenLabelMaxSizeChanged
Occurs when the ScreenLabelMaxSize property value changes.
Public eventScreenLabelMinSizeFactorChanged
Occurs when the ScreenLabelMinSizeFactor property value changes.
Public eventSelectedColorChanged
Occurs when the SelectedColor property value changes.
Public eventShowCenteringBordersChanged
Occurs when the ShowCenteringBorders property value changes.
Public eventSimulationStep
Occurs during the simulation step.
(Inherited from Component.)
Public eventSimulationStepsPerSecondChanged
Occurs when the SimulationStepsPerSecond property value changes.
Public eventSoundVolumeChanged
Occurs when the SoundVolume property value changes.
Public eventSplashScreenAtStartupChanged
Occurs when the SplashScreenAtStartup property value changes.
Public eventThemeChanged
Occurs when the Theme property value changes.
Public eventUpdateEvent
Occurs during the update process of all objects.
(Inherited from Component.)
Public eventWindowSizeChanged
Occurs when the WindowSize property value changes.
Public eventWindowStateChanged
Occurs when the WindowState property value changes.
Top
Fields
  NameDescription
Public fieldStatic memberWindowSizeDefault
Top
Extension Methods
See Also