ZShifter Class

Provides a flow job element as a container to execute child job elements iteratively with translation.

Inheritance Hierarchy

SystemObject
  RAYLASE.Marker.PluginBasePlugin
    RAYLASE.Marker.JobElementBaseJobElement
      RAYLASE.Marker.JobElementBaseFlowJobElement
        RAYLASE.Marker.JobElementBaseLoopFlow
          RAYLASE.MarkerPlugin.JobElementsZShifter

Namespace: RAYLASE.MarkerPlugin.JobElements
Assembly: RAYLASE.MarkerPlugin (in RAYLASE.MarkerPlugin.dll) Version: 2.19.0

Syntax

Copy

public class ZShifter : BaseLoopFlow

The ZShifter type exposes the following members.

Constructors

	Name	Description
	ZShifter	Initializes a new instance of the Object class.

Top

Properties

	Name	Description
	ApplicationDataDirectory	The directory where application data, such as logs and configurations, are stored. (Inherited from BaseJobElement)
	CanOutputSingleJobElement	(Inherited from BaseFlowJobElement)
	Children	The list of the child job elements. (Inherited from BaseFlowJobElement)
	Condition	The binning condition for the holder of the job element. (Inherited from BaseJobElement)
	ConfigurationManager	(Inherited from BasePlugin)
	CurrentIteration	The current iteration index. (Inherited from BaseLoopFlow)
	DeviceManager	(Inherited from BaseJobElement)
	DirtyFlagLocker	The lock object for property modification. (Inherited from BaseJobElement)
	DoHandleConditionPortChangedDelegate	(Inherited from BaseJobElement)
	HasConditionValueOverride	The flag to indicate that the condition is used for the direct children and each can override the condition value. The container itself does not use the binning. (Inherited from BaseFlowJobElement)
	InternalChildren	The list of the child job elements, in read-write form. (Inherited from BaseFlowJobElement)
	InternalIterations	The number of iterations that will be performed. (Inherited from BaseLoopFlow)
	IsAborted	The flag to indicate whether this job element has stopped processing its children in case of error. (Inherited from BaseFlowJobElement)
	IsDirty	The flag to indicate whether the content of this job element has been modified. (Inherited from BaseJobElement)
	IsNonAtomic	Obsolete. The flag to indicate whether the children execution will be intermingled with other outside job elements. This is only meaningful if the parent's IsParallel is true. (Inherited from BaseFlowJobElement)
	IsParallel	Obsolete. The flag to indicate whether the children will be executed in parallel. (Inherited from BaseFlowJobElement)
	JobElementID	The unique ID of the job element. If the concrete class inherits from BaseJobElement, the JobElementID of the BaseJobElement will be prefilled. Recommended not to be changed. (Inherited from BaseJobElement)
	LogDirectory	The directory of the log file. (Inherited from BasePlugin)
	Logger	The common logger. (Inherited from BasePlugin)
	MarkableConfiguration	The configuration of this flow job element. (Inherited from BaseFlowJobElement)
	OutputSingleJobElement	(Inherited from BaseFlowJobElement)
	PluginMetadata	The metadata of the plugin instances. If the concrete class inherits from the BasePluginSetup interface, the metadata of the BasePluginSetup will be prefilled. (Inherited from BasePlugin)
	PropertyMask	(Inherited from BaseJobElement)
	Repeat	If true the job element will be executed repeatedly (Inherited from BaseLoopFlow)
	Rotation	Rotation to apply after each execution.
	Shifts	Sequence of shifts containing the number of executions and the delta z.
	ShowConditionControllerUIDelegate	The delegate to show the controller UI because no ports have been defined. (Inherited from BaseJobElement)
	UseMaxFlowJobElementExecutions	The flag to indicate whether this flow job element honors the value of maximum executions that is passed via the Execute method. (Inherited from BaseLoopFlow)
	VariableManager	(Inherited from BaseJobElement)
	VariableScopeName	(Inherited from BaseJobElement)

Top

Methods

	Name	Description
	AddJobElement	Adds a job element as a child. (Inherited from BaseFlowJobElement)
	CalculateOffsetToCenter	(Inherited from BaseLoopFlow)
	CenterToOrigin	Moves the job element so that its centroid is at the origin. (Inherited from BaseFlowJobElement)
	ClearAllJobElements	Removes all child items. (Inherited from BaseFlowJobElement)
	CompareWith	(Inherited from BaseJobElement)
	CopyFrom	Copies the source job element into this job element. (Inherited from BaseJobElement)
	Dispose	(Inherited from BasePlugin)
	Dispose(Boolean)	(Inherited from BasePlugin)
	DisposeUI	(Inherited from BaseFlowJobElement)
	DoClearAllJobElements	Removes all child items of a given list. (Inherited from BaseFlowJobElement)
	DoCompareWith	(Inherited from BaseJobElement)
	DoDisposeUI	(Inherited from BasePlugin)
	DoExecuteJobElements	Process the child job elements relative to this job element. Each child can be modified by a local process configuration. (Inherited from BaseFlowJobElement)
	DoGetUIMask	(Inherited from BaseJobElement)
	DoInsertJobElement	Inserts a job element as a child of a given list. (Inherited from BaseFlowJobElement)
	DoRemoveJobElement	Removes a child job element from a given list. (Inherited from BaseFlowJobElement)
	DoShowUI(String)	(Inherited from BaseJobElement)
	DoShowUI(JobElementHolder, String)	(Overrides BaseJobElementDoShowUI(JobElementHolder, String))
	DoShowUI(JobElementHolder, String, PropertyMask)	(Inherited from BaseJobElement)
	DoShowUICallback(PluginSettingsView)	This callback method is called when a GUI settings dialog is closed with Apply or OK and is used to extract the changed properties from a settings dialog in the GUI. (Inherited from BaseJobElement)
	DoShowUICallback(JobElementHolder, PluginSettingsView)	(Overrides BaseJobElementDoShowUICallback(JobElementHolder, PluginSettingsView))
	ExecuteJobElements	Iterates the child job elements N times. (Inherited from BaseLoopFlow)
	Flip	Flip the job element against given flags for axes. (Inherited from BaseFlowJobElement)
	GenerateLocalTag	(Inherited from BaseJobElement)
	GetBoundingBox	(Inherited from BaseFlowJobElement)
	GetCounter	(Overrides BaseLoopFlowGetCounter(NullableInt32))
	GetUIMask	(Inherited from BaseJobElement)
	HandleChildJobElementProcessingStarting	Propagates the event received from the helper back to the top executor. (Inherited from BaseFlowJobElement)
	HandleConditionPortChanged	Performs necessary adjustments whenever the controller has updated its ports. (Inherited from BaseJobElement)
	HandleLocalChildJobElementIsAvailable	Handles the event received from the helper that a child job element is found. (Inherited from BaseLoopFlow)
	HasDynamicChild	Returns whether this job element contains a dynamic job element recursively. (Inherited from BaseFlowJobElement)
	HasInfinitePassChild	Returns whether this job element contains a child with an infinite pass recursively. (Inherited from BaseFlowJobElement)
	HasNonFlowChild	Returns whether this job element contains a job element that is not a flow job element. (Inherited from BaseFlowJobElement)
	HasPoint	Tests whether a point is inside (inclusively) the job element. This applies only if the job element is on a single plane. (Inherited from BaseFlowJobElement)
	Initialize	Plug-in specific initialization can be done here if necessary. (Inherited from BasePlugin)
	InsertJobElement	Inserts a job element as a child. (Inherited from BaseFlowJobElement)
	IsChildEditable	(Inherited from BaseLoopFlow)
	ModifyChildProcessingHolder	(Inherited from BaseLoopFlow)
	MoveTo	Moves the job element so that its centroid is at the given position. (Inherited from BaseFlowJobElement)
	PostAllItemIteration	Executes the necessary steps after each iteration is performed. (Inherited from BaseLoopFlow)
	PostExecute	Executes the necessary steps after the job elements were processed. (Inherited from BaseFlowJobElement)
	PreAllItemIteration	(Overrides BaseLoopFlowPreAllItemIteration(ProcessingHolder, ProcessingHolder, MarkableConfiguration, MarkableConfiguration, Guid, NullableInt32))
	PreExecute	(Overrides BaseFlowJobElementPreExecute(ProcessingHolder, ProcessingHolder, MarkableConfiguration, Guid, NullableInt32))
	RemoveJobElement	Removes a child job element. (Inherited from BaseFlowJobElement)
	Rotate(Double)	Rotates the job element a given angle around the z-axis. (Inherited from BaseFlowJobElement)
	Rotate(Double, dvec3)	Rotates the job element a given angle with respect to a given vector passing through its centroid. (Inherited from BaseFlowJobElement)
	Scale(Double)	Scales the job element uniformly with respect to its centroid. (Inherited from BaseFlowJobElement)
	Scale(dvec3)	Scales the job element non-uniformly with respect to its centroid. (Inherited from BaseFlowJobElement)
	ShowUI(String)	(Inherited from BaseJobElement)
	ShowUI(JobElementHolder, String)	(Inherited from BaseJobElement)
	ShowUI(JobElementHolder, String, PropertyMask)	(Inherited from BaseFlowJobElement)
	ShowUICallback(PluginSettingsView)	(Inherited from BaseJobElement)
	ShowUICallback(JobElementHolder, PluginSettingsView)	(Inherited from BaseFlowJobElement)
	ShowUICancelCallback(PluginSettingsView)	Invokes the callback that can be used when the ShowUI method is done and the user pressed the cancel button (Inherited from BasePlugin)
	ShowUICancelCallback(JobElementHolder, PluginSettingsView)	(Inherited from BaseJobElement)
	ToString	(Inherited from BasePlugin)
	Transform	Multiplies the model matrix with a transformation matrix. (Inherited from BaseFlowJobElement)
	Translate	Translates the job element with a given vector. (Inherited from BaseFlowJobElement)
	UpdateFieldT	Updates the Property to the value by using DirtyFlagLocker and setting IsDirty . (Inherited from BaseJobElement)

Top

Events

	Name	Description
	ChildJobElementProcessingStarting	Raised when a child job element is started being processed by a flow job element. (Inherited from BaseFlowJobElement)

Top

Reference

RAYLASE.MarkerPlugin.JobElements Namespace