Click or drag to resize
Ab4d.SharpEngine logo

RenderingStep Class

RenderingStep is an abstract base class for other rendering step classes. It does not define any rendering logic but provides handling BeforeRunningStep and AfterRunningStep event handling.
Inheritance Hierarchy
SystemObject
  Ab4d.SharpEngine.CoreComponentBase
    Ab4d.SharpEngine.RenderingStepsRenderingStep
      More

Namespace: Ab4d.SharpEngine.RenderingSteps
Assembly: Ab4d.SharpEngine (in Ab4d.SharpEngine.dll) Version: 2.0.8956+4c7684e186ca1be74e7a284fbe739d9a1b843d3c
Syntax
C#
Copy
public abstract class RenderingStep : ComponentBase, 
	IDisposable

The RenderingStep type exposes the following members.

Constructors
 NameDescription
Protected methodRenderingStep Constructor
Top
Properties
 NameDescription
Public propertyDescription Gets a description of this rendering step.
Public propertyIsEnabled Gets or sets a boolean that specifies if this rendering step is enabled. Note that if the step is not enabled than the step events will also not be triggered.
Public propertyNextRenderingStep Gets the next RenderingStep.
Public propertyPreviousRenderingStep Gets the previous RenderingStep.
Public propertySceneView Gets the parent SceneView.
Top
Methods
 NameDescription
Public methodDispose 
Protected methodDispose(Boolean) Dispose this rendering step and all child rendering steps
(Overrides ComponentBaseDispose(Boolean))
Protected methodOnAddedToRenderingStepsList OnAddedToRenderingStepsList is called when this RenderingStep is added to the RenderingSteps collection.
Protected methodOnAfterRunningStep OnAfterRunningStep
Protected methodOnBeforeRunningStep OnBeforeRunningStep
Protected methodOnIsEnabledChanged OnIsEnabledChanged is called when the IsEnabled is changed.
Protected methodOnLoaded OnLoaded is called when this rendering step is added to the RenderingStepsList.
Protected methodOnRemovedFromRenderingStepsList OnRemovedFromRenderingStepsList is called when this RenderingStep is removed to the RenderingSteps collection.
Protected methodOnRun OnRun abstract method executes the code for this rendering step. The method should true to continue executing rendering steps; when false is returned then rendering is terminated.
Protected methodOnUnloaded OnUnloaded is called when this rendering step is removed from the RenderingStepsList.
Public methodRun Runs the rendering step. When false is returned then rendering is terminated.
Public methodSaveExecutionTimeStatistics SaveExecutionTimeStatistics is called when we are collecting statistics. The implementation of the method should save or add the elapsedMilliseconds to the corresponding property in the RenderingStatistics class.
Public methodToString Returns a string that represents the current object.
(Overrides ObjectToString)
Top
Events
 NameDescription
Public eventAfterRunningStep AfterRunningStep is raised after this rendering step is run.
Public eventBeforeRunningStep BeforeRunningStep is raised before this rendering step is run.
Top
See Also
Inheritance Hierarchy