Click or drag to resize
Ab4d.SharpEngine logo

RenderingStepsGroup Class

RenderingStepsGroup is a rendering step that can group multiple rendering steps inside its Children list of rendering steps.
Inheritance Hierarchy
SystemObject
  Ab4d.SharpEngine.CoreComponentBase
    Ab4d.SharpEngine.RenderingStepsRenderingStep
      Ab4d.SharpEngine.RenderingStepsRenderingStepsGroup

Namespace: Ab4d.SharpEngine.RenderingSteps
Assembly: Ab4d.SharpEngine (in Ab4d.SharpEngine.dll) Version: 2.0.8956+4c7684e186ca1be74e7a284fbe739d9a1b843d3c
Syntax
C#
public class RenderingStepsGroup : RenderingStep

The RenderingStepsGroup type exposes the following members.

Constructors
 NameDescription
Public methodRenderingStepsGroup Constructor
Top
Properties
 NameDescription
Public propertyChildren Gets RenderingStepsList that holds the child rendering steps.
Top
Methods
 NameDescription
Protected methodDispose Dispose this rendering step and all child rendering steps
(Overrides RenderingStepDispose(Boolean))
Protected methodOnAddedToRenderingStepsList OnAddedToRenderingStepsList is called when this RenderingStep is added to the RenderingSteps collection.
(Overrides RenderingStepOnAddedToRenderingStepsList)
Protected methodOnRemovedFromRenderingStepsList OnRemovedFromRenderingStepsList is called when this RenderingStep is removed to the RenderingSteps collection.
(Overrides RenderingStepOnRemovedFromRenderingStepsList)
Protected methodOnRun The method should true to continue executing rendering steps; when false is returned then rendering is terminated.
(Overrides RenderingStepOnRun(RenderingContext))
Public methodToString Returns a string that represents the current object.
(Overrides RenderingStepToString)
Top
Remarks

RenderingStepsGroup is a rendering step that can group multiple rendering steps inside its Children list of rendering steps.

RenderingStepsGroup differences from other rendering steps:
- The OnRun(RenderingContext) method is never called for RenderingStepsGroup
- The event BeforeRunningStep is called before the first child is executed.
- The event AfterRunningStep is called after the last child is executed.

See Also