Show / Hide Table of Contents

Class Environment.Scene

Inheritance
System.Object
Environment.Scene
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Experior.Core
Assembly: Experior.Core.dll
Syntax
public class Scene

Fields

Coordinates

Declaration
public static bool Coordinates
Field Value
Type Description
System.Boolean

DefaultColor

Declaration
public static Color DefaultColor
Field Value
Type Description
System.Windows.Media.Color

InvertSelectionColor

Declaration
public static Color InvertSelectionColor
Field Value
Type Description
System.Windows.Media.Color

LabelColor

Declaration
public static Color LabelColor
Field Value
Type Description
System.Windows.Media.Color

SelectionColor

Declaration
public static Color SelectionColor
Field Value
Type Description
System.Windows.Media.Color

Properties

ActiveSection

Declaration
public static ISection ActiveSection { get; }
Property Value
Type Description
ISection

CurrentFileName

Declaration
public static string CurrentFileName { get; }
Property Value
Type Description
System.String

Disposing

Declaration
public static bool Disposing { get; }
Property Value
Type Description
System.Boolean

Loading

Declaration
public static bool Loading { get; }
Property Value
Type Description
System.Boolean

Locked

Declaration
public static bool Locked { get; }
Property Value
Type Description
System.Boolean

LockedColor

Declaration
public static Color LockedColor { get; set; }
Property Value
Type Description
System.Windows.Media.Color

NumberOfActors

Declaration
public static int NumberOfActors { get; }
Property Value
Type Description
System.Int32

NumberOfKinematicActors

Declaration
public static int NumberOfKinematicActors { get; }
Property Value
Type Description
System.Int32

Paused

Declaration
public static bool Paused { get; }
Property Value
Type Description
System.Boolean

PhysXScene

Declaration
public static PhysX.Scene PhysXScene { get; }
Property Value
Type Description
PhysX.Scene

Shadow

Declaration
public static int Shadow { get; set; }
Property Value
Type Description
System.Int32

Title

Declaration
public static string Title { get; set; }
Property Value
Type Description
System.String

Methods

Clear(ClearFilter)

Declaration
public static void Clear(ClearFilter filter)
Parameters
Type Name Description
ClearFilter filter

Continue()

Resumes the engine playback.

Declaration
public static void Continue()

DeselectAll()

Deselects anything selected, by calling DeselectAll(Object) with null as argument.

Declaration
public static void DeselectAll()

DeselectAll(Object)

Deselects anything selected. The method will handle most of the deselect logic, but will also invoke the OnAllDeselected event.

Declaration
public static void DeselectAll(object sender)
Parameters
Type Name Description
System.Object sender

Dirty()

Declaration
public static void Dirty()

ExportGraphics(String)

Export the current scene to a COLLADA file

Declaration
public static void ExportGraphics(string filename)
Parameters
Type Name Description
System.String filename

ExportGraphics(String, Action)

Declaration
public static void ExportGraphics(string filename, Action exported)
Parameters
Type Name Description
System.String filename
System.Action exported

HideSection(String)

Makes the section invisible.

Declaration
public static void HideSection(string sectionName)
Parameters
Type Name Description
System.String sectionName

The section name to make visible.

Lock()

Locks the scene.

Declaration
public static void Lock()
Remarks

Locking the scene will disables movement of assemblies by the mouse. The properties in the property grid are still visible, bot to editable. It's common to lock the scene when testing a model that has already been built. It will prevent the user from accidentally moving assemblies. PLease see zUnLock()

Open(String)

Declaration
public static void Open(string filename)
Parameters
Type Name Description
System.String filename

Pause()

Declaration
public static void Pause()

Reset()

Resets the scene. The reset method will delete all Deletable loads. It will call the Reset() reset method of the assemblies. The assemblies should the go back to a default state such that they are rady to a new test after reset.

Declaration
public static void Reset()

Save(String)

Saves the current scene to the specified filepath. If '.experior' is not included in the filepath it will be saves as a directory. Otherwise it will nbe saved as an Experior file.

Declaration
public static void Save(string filePath)
Parameters
Type Name Description
System.String filePath

The filepath to use.

Exceptions
Type Condition
System.ArgumentNullException

Will be thrown if the filepath is invalid

Save(String, Boolean)

Saves the current scene to the specified filepath.

Declaration
public static void Save(string filePath, bool archive)
Parameters
Type Name Description
System.String filePath

The filepath to use.

System.Boolean archive

Will save the scene as an .Experior file if true, else it will save the scene as a directory.

Exceptions
Type Condition
System.ArgumentNullException

Will be thrown if the filepath is invalid

ShowSection(String)

Makes the section visible.

Declaration
public static void ShowSection(string sectionName)
Parameters
Type Name Description
System.String sectionName

The section name to make visible.

UnLock()

Unlocks the scene.

Declaration
public static void UnLock()
Remarks

Please see. Lock()

Events

CloseLabel

Declaration
public static event Environment.Scene.Event CloseLabel
Event Type
Type Description
Environment.Scene.Event

OnAllDeselected

Declaration
public static event Environment.Scene.AllDeselectedEvent OnAllDeselected
Event Type
Type Description
Environment.Scene.AllDeselectedEvent

OnAssemblySelected

Declaration
public static event Environment.Scene.AssemblySelectedEvent OnAssemblySelected
Event Type
Type Description
Environment.Scene.AssemblySelectedEvent

OnBeforeLoadingReplacingAssemblyFullnames

Declaration
public static event Environment.Scene.LoadingReplacingEvent OnBeforeLoadingReplacingAssemblyFullnames
Event Type
Type Description
Environment.Scene.LoadingReplacingEvent

OnBeforeLoadingReplacingAssemblyNames

Declaration
public static event Environment.Scene.LoadingReplacingEvent OnBeforeLoadingReplacingAssemblyNames
Event Type
Type Description
Environment.Scene.LoadingReplacingEvent

OnBeforeLoadingReplacingAssemblyPropertyNames

Declaration
public static event Environment.Scene.LoadingReplacingEvent OnBeforeLoadingReplacingAssemblyPropertyNames
Event Type
Type Description
Environment.Scene.LoadingReplacingEvent

OnBeforeReset

Declaration
public static event Environment.Scene.BeforeResetEvent OnBeforeReset
Event Type
Type Description
Environment.Scene.BeforeResetEvent

OnBeforeSaving

Declaration
public static event Environment.Scene.Event OnBeforeSaving
Event Type
Type Description
Environment.Scene.Event

OnCleared

Declaration
public static event Environment.Scene.Event OnCleared
Event Type
Type Description
Environment.Scene.Event

OnFileDrop

Declaration
public static event Environment.Scene.FileDropEvent OnFileDrop
Event Type
Type Description
Environment.Scene.FileDropEvent

OnKeyDown

Declaration
public static event Environment.Scene.KeyDownEvent OnKeyDown
Event Type
Type Description
Environment.Scene.KeyDownEvent

OnLoaded

Declaration
public static event Environment.Scene.Event OnLoaded
Event Type
Type Description
Environment.Scene.Event

OnLocked

Declaration
public static event Environment.Scene.Event OnLocked
Event Type
Type Description
Environment.Scene.Event

OnLockedColorChanged

Declaration
public static event Environment.Scene.Event OnLockedColorChanged
Event Type
Type Description
Environment.Scene.Event

OnMouseUp

Declaration
public static event Environment.Scene.MouseUpEvent OnMouseUp
Event Type
Type Description
Environment.Scene.MouseUpEvent

OnPaused

Declaration
public static event Environment.Scene.Event OnPaused
Event Type
Type Description
Environment.Scene.Event

OnPick

Declaration
public static event Environment.Scene.PickEvent OnPick
Event Type
Type Description
Environment.Scene.PickEvent

OnResetCompleted

Declaration
public static event Environment.Scene.ResetCompletedEvent OnResetCompleted
Event Type
Type Description
Environment.Scene.ResetCompletedEvent

OnSaved

Declaration
public static event Environment.Scene.Event OnSaved
Event Type
Type Description
Environment.Scene.Event

OnSelected

Declaration
public static event Environment.Scene.SelectedEvent OnSelected
Event Type
Type Description
Environment.Scene.SelectedEvent

OnShadowChanged

Declaration
public static event Environment.Scene.ShadowChangedEvent OnShadowChanged
Event Type
Type Description
Environment.Scene.ShadowChangedEvent

OnStarted

Declaration
public static event Environment.Scene.Event OnStarted
Event Type
Type Description
Environment.Scene.Event

OnStarting

Declaration
public static event Environment.Scene.Event OnStarting
Event Type
Type Description
Environment.Scene.Event

OnStep

Declaration
public static event Environment.Scene.StepEvent OnStep
Event Type
Type Description
Environment.Scene.StepEvent

OnUnLocked

Declaration
public static event Environment.Scene.Event OnUnLocked
Event Type
Type Description
Environment.Scene.Event

ShowLabel

Declaration
public static event Environment.Scene.ShowLabelEvent ShowLabel
Event Type
Type Description
Environment.Scene.ShowLabelEvent
Back to top Generated by DocFX