Click or drag to resize

MarkerPen Class

Provides properties of a marker pen.
Inheritance Hierarchy
SystemObject
  RAYLASE.Marker.CommonMarkerPen

Namespace: RAYLASE.Marker.Common
Assembly: RAYLASE.Marker.Common (in RAYLASE.Marker.Common.dll) Version: 2.55.0
Syntax
C#
Copy
public class MarkerPen

The MarkerPen type exposes the following members.

Constructors
 NameDescription
Public methodMarkerPenInitializes a new instance of the MarkerPen class
Top
Properties
 NameDescription
Public propertyBeamProfileID The index of the type of beam to be used by the laser, if the laser supports beam selection.
Public propertyColor Color displayed in the GUI
Public propertyDashedLine Enables dashed line feature.
Public propertyDashedLineOffset The start offset of the DashedLinePattern.
Public propertyDashedLinePattern The on/off patterns for dashed lines. The value is comma separated.
Public propertyJumpDelay The jump delay.
Public propertyJumpLengthLimit When VariableJumpDelay is enabled this is the maximum length of a jump vector for which the variable jump delay is being considerated.
Public propertyJumpSpeed The jump speed.
Public propertyLaserFrequency The frequency of the laser modulation signal (LM).
Public propertyLaserOffDelay The laser off delay.
Public propertyLaserOnDelay The laser on delay.
Public propertyLaserOutputMode Determines whether the laser is pulsed or continuous wave (if supported).
Public propertyLaserPower Gets or sets the laser output power as a factor from 0 to 1.
Public propertyLmWidth The width of the laser modulation signal (LM).
Public propertyMarkDelay The mark delay.
Public propertyMarkSpeed The mark speed.
Public propertyMinJumpDelay When VariableJumpDelay is enabled this is the minimum jump delay.
Public propertyMustHaveValue The flag to indicate whether pen property can be null.
Public propertyName The displayed name of the pen.
Public propertyOpticalPulseWidth If available the optical pulse width. Negative values will not be sent to the laser.
Public propertyOpticalPulseWidthIndex If available the optical pulse width index.
Public propertyPolyDelay The poly delay.
Public propertyPulseShapePowerIsPercentageOfPen Whether the power in PulseShapeSegments (except -1, which always means the pen's full power) is a fraction of the pen's power, instead of an absolute fraction of the max power. This lets the pulse shape track changes to the pen's power.
Public propertyPulseShapeSegments (For main power) Pulse shape. Each value is a tuple of the time (in time mode) and the power. The start position or time has to be zero, and it needs to be increasing. This is relative to the end of the vector. The power can be -1 to refer to the pen's own power. If PulseShapePowerIsPercentageOfPen is set, every other value is a fraction of the pen's power instead of an absolute fraction of the max power.
Public propertyPulseShaping Enables pulse shaping.
Public propertyRampingEndSegments (For main power) Ramping values at the end of the vector. Each value is a tuple of the position (in distance mode) or the time (in time mode) and the power. The start position or time has to be zero, and it needs to be increasing. This is relative to the end of the vector. The power can be -1 to refer to the pen's own power. If RampingPowerIsPercentageOfPen is set, every other value is a fraction of the pen's power instead of an absolute fraction of the max power.
Public propertyRampingMode Ramping mode at the start of the vector.
Public propertyRampingPowerIsPercentageOfPen Whether the power in RampingStartSegments and RampingEndSegments (except -1, which always means the pen's full power) is a fraction of the pen's power, instead of an absolute fraction of the max power. This lets the ramp shape track changes to the pen's power.
Public propertyRampingStartSegments (For main power) Ramping values at the start of the vector. Each value is a tuple of the position (in distance mode) or the time (in time mode) and the power. The start position or time has to be zero, and it needs to be increasing. This is relative to the start of the vector. The power can be -1 to refer to the pen's own power. If RampingPowerIsPercentageOfPen is set, every other value is a fraction of the pen's power instead of an absolute fraction of the max power.
Public propertySecondaryPower Secondary power. 1 is equal to max power eg 10V.
Public propertySecondaryPulseShapePowerIsPercentageOfPen Whether the power in SecondaryPulseShapeSegments (except -1, which always means the pen's full power) is a fraction of the pen's power, instead of an absolute fraction of the max power. This lets the pulse shape track changes to the pen's power.
Public propertySecondaryPulseShapeSegments (For secondary power) Pulse shape. Each value is a tuple of the time (in time mode) and the power. The start position or time has to be zero, and it needs to be increasing. This is relative to the start of the vector. The power can be -1 to refer to the pen's own power. If SecondaryPulseShapePowerIsPercentageOfPen is set, every other value is a fraction of the pen's power instead of an absolute fraction of the max power.
Public propertySecondaryRampingEndSegments (For secondary power) Ramping values at the end of the vector. Each value is a tuple of the position (in distance mode) or the time (in time mode) and the power. The start position or time has to be zero, and it needs to be increasing. This is relative to the end of the vector. The power can be -1 to refer to the pen's own power. If SecondaryRampingPowerIsPercentageOfPen is set, every other value is a fraction of the pen's power instead of an absolute fraction of the max power.
Public propertySecondaryRampingPowerIsPercentageOfPen Whether the power in SecondaryRampingStartSegments and SecondaryRampingEndSegments (except -1, which always means the pen's full power) is a fraction of the pen's power, instead of an absolute fraction of the max power. This lets the ramp shape track changes to the pen's power.
Public propertySecondaryRampingStartSegments (For secondary power) Ramping values at the start of the vector. Each value is a tuple of the position (in distance mode) or the time (in time mode) and the power. The start position or time has to be zero, and it needs to be increasing. This is relative to the start of the vector. The power can be -1 to refer to the pen's own power. If SecondaryRampingPowerIsPercentageOfPen is set, every other value is a fraction of the pen's power instead of an absolute fraction of the max power.
Public propertyShouldMark Determines whether the path using this pen is getting marked.
Public propertySkyWritingAccelerationDelay The acceleration delay for skywriting feature.
Public propertySkyWritingDecelerationDelay The deceleration delay for skywriting feature.
Public propertySkyWritingExtensionTime The extension time for skywriting feature.
Public propertySkyWritingLaserOffDelay The laser off delay for skywriting feature.
Public propertySkyWritingLaserOnDelay The laser on delay used for sky writing.
Public propertySkyWritingMergedExtensionsMaxCoH The minimum change of heading between successive mark vectors, above which skywriting will be performed.
Public propertySkyWritingMinCoH The minimum change of heading for skywriting.
Public propertySkyWritingMode Sets the SkyWritingMode
Public propertyVariableJumpDelay Enables or disables the variable jump delay.
Public propertyVariablePolyDelay Enables or disables the variable polygon delay.
Public propertyVelocityPowerCorrection Enables velocity based power correction.
Public propertyWaveform Waveform used by the laser.
Public propertyWobbleAmplitude Amplitude of the wobble shape.
Public propertyWobbleFrequency Frequency of the wobble shape.
Public propertyWobbleMode Mode of wobbling
Public propertyWobblePhase Phase of the wobble shape
Public propertyZoomAsync Gets or sets the zoom async flag.
Public propertyZoomFactor Gets or sets the zoom factor.
Public propertyZoomSpeed Gets or sets the zoom speed [factor/µs].
Top
Methods
 NameDescription
Public methodCompareWith Updates a masking pen to indicate which properties are the same. A null value indicates that the properties are different.
Public methodCopyFrom(MarkerPen) Copies all properties and also the name from the given pen.
Public methodCopyFrom(MarkerPen, MarkerPen) Copies all properties and also the name from the given pen, but use the masking pen to decide which properties should be updated.
Public methodGetPropertyValue 
Public methodInheritValuesFrom(MarkerPen) Inherits values from the given pen.
Public methodInheritValuesFrom(MarkerPen, MarkerPen) Inherits values from the given pen, but use the masking pen to decide which properties should be updated.
Public methodIsAllDefault Returns whether all pen properties are defaults (null).
Public methodIsSame Returns true if pen is the same.
Public methodResetToDefault Reset all properties to its default values.
Public methodSetPropertyValue 
Public methodToStringReturns a string that represents the current object.
(Overrides ObjectToString)
Top
See Also