    

 ## On this page

  

 

 # SpeosDes

 Last update: 17.07.2025 

## Command

### Static method

NameDescriptionSyntaxGetErrorStatusGet the error status of the given objectstring GetErrorStatus(object docObject)IsUpToDateAsk if the given object was modified since its last successful computationbool IsUpToDate(object docObject)SetActiveSelectionSet the active selection from a collection of DocObjectsvoid SetActiveSelection(ICollection selectedObjects)GetSpeosObjectsInActivePartGet the Speos objects contained in the active PartIEnumerable GetSpeosObjectsInActivePart()Computevoid Compute(System.Object\[\] selectedObjects)ComputePerform the computation of an array of DocObjectsvoid Compute(SpaceClaim.Api.V242.IDocObject\[\] selectedObjects)ComputePerform the computation of an array of script objectsvoid Compute(Inf.SpaceClaim.Automation.IApiSpeosDocObject\[\] selectedObjects)ComputeOnActiveSelectionPerform the computation of the active selectionvoid ComputeOnActiveSelection()## Aspherics

### Static method

NameDescriptionSyntaxCreateCreate a new object of this typeSpeosDes.Aspherics Create()### Method

NameDescriptionSyntaxToStringstring ToString()### Property

NameDescriptionSyntaxIndexNumber attributeint IndexIndexTextNumber attribute (as text)string IndexTextValueNumber attributedouble ValueValueTextNumber attribute (as text)string ValueText## CircularLens

### Static method

NameDescriptionSyntaxFromSelectionConvert Items of a ScriptSelection to a list of Speos objects when their type is matching.IEnumerable&lt;SpeosDes.CircularLens&gt; FromSelection(IEnumerable&lt;SpaceClaim.Api.V242.IDocObject&gt; selectionItems)FindReturns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.\*")SpeosDes.CircularLens Find(string objectName)CreateCreate a new object of this type under the specified parent componentSpeosDes.CircularLens Create(object parent)CreateCreate a new object in the active contextSpeosDes.CircularLens Create()### Method

NameDescriptionSyntaxCloneCreate a copy of this object in the active contextSpeosDes.CircularLens Clone()CopyToCreate a copy of this object and paste it to the specified destinationSpeosDes.CircularLens CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)AddGroupCall the 'AddGroup' command.void AddGroup()FindOccurrenceInActivePartSearch for occurrences of this object in the active Partobject FindOccurrenceInActivePart()FindOccurrenceInContextOfSearch for occurrences of this object in the specified PartSpaceClaim.Api.V242.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V242.IDocObject contextObject)ToStringGet a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable)string ToString()DeleteDelete this objectbool Delete()GetChildSubjectsRetrieve all children as DocObjectsIEnumerable&lt;SpaceClaim.Api.V242.CustomObject&gt; GetChildSubjects()GetChildrenRetrieve all direct children of a given typeIEnumerable&lt;TSpecificApiType&gt; GetChildren&lt;TSpecificApiType&gt;()ComputeExecute the Compute command on the objectvoid Compute()PublishParameterPublish or un-publish a number attribute as driving parametervoid PublishParameter(string fieldName, bool trueToPublish)PublishAllParametersToWorkbenchCall this method to expose all object's attributes so that they can be accessible and driven from Workbench.void PublishAllParametersToWorkbench(bool trueToPublish)ApplyPresetUpdate the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error.void ApplyPreset(string presetFilePath)ExportToPresetExport the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error.string ExportToPreset(string filePath)### Property

NameDescriptionSyntaxStyleChild CustomObject attributeSpeosDes.OpticalFeatureStyleCircular StyleGeneralChild CustomObject attributeSpeosDes.OpticalFeatureGeneral GeneralGroupsChildren CustomObjects attributeSpeosDes.CircularLens.CircularLensGroups GroupsManufacturingChild CustomObject attributeSpeosDes.OpticalFeatureManufacturing ManufacturingExcelFileFile attributeFou.Utils.ValueObjects.FilePath ExcelFileExcelFileFullPathFile attribute (absolute full path)string ExcelFileFullPathSubjectDeprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapperSpaceClaim.Api.V242.CustomObject SubjectOccurrenceGet the underlying CustomObject occurrence, associated to the API object wrapper in current API versionobject OccurrenceNameGet or Set the name of the objectstring NameVisibleChange the visibility status (same behavior as checking/unchecking on the tree view item)bool VisibleStatusInfoGet the status of the object (warning or error message)string StatusInfoIsUpToDateAsk if the object was modified since its last successful computationbool IsUpToDate### CircularLens.CircularLensGroups

### Method

NameDescriptionSyntaxGetEnumeratorGet children CustomObjects enumerationIEnumerator&lt;SpeosDes.OpticalGroup&gt; GetEnumerator()AddNewCreate a new child CustomObjectSpeosDes.OpticalGroup AddNew(int insertIndex)DeleteDelete a child CustomObject by indexvoid Delete(int index)### Property

NameDescriptionSyntaxCountGet children CustomObjects countint CountListGet children CustomObjects listIReadOnlyCollection&lt;SpeosDes.OpticalGroup&gt; ListItemGet child CustomObject by indexSpeosDes.OpticalGroup ItemItemGet child CustomObject by indexSpeosDes.OpticalGroup Item## CircularSurface

### Static method

NameDescriptionSyntaxFromSelectionConvert Items of a ScriptSelection to a list of Speos objects when their type is matching.IEnumerable&lt;SpeosDes.CircularSurface&gt; FromSelection(IEnumerable&lt;SpaceClaim.Api.V242.IDocObject&gt; selectionItems)FindReturns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.\*")SpeosDes.CircularSurface Find(string objectName)CreateCreate a new object of this type under the specified parent componentSpeosDes.CircularSurface Create(object parent)CreateCreate a new object in the active contextSpeosDes.CircularSurface Create()### Method

NameDescriptionSyntaxCloneCreate a copy of this object in the active contextSpeosDes.CircularSurface Clone()CopyToCreate a copy of this object and paste it to the specified destinationSpeosDes.CircularSurface CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)AddGroupCall the 'AddGroup' command.void AddGroup()FindOccurrenceInActivePartSearch for occurrences of this object in the active Partobject FindOccurrenceInActivePart()FindOccurrenceInContextOfSearch for occurrences of this object in the specified PartSpaceClaim.Api.V242.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V242.IDocObject contextObject)ToStringGet a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable)string ToString()DeleteDelete this objectbool Delete()GetChildSubjectsRetrieve all children as DocObjectsIEnumerable&lt;SpaceClaim.Api.V242.CustomObject&gt; GetChildSubjects()GetChildrenRetrieve all direct children of a given typeIEnumerable&lt;TSpecificApiType&gt; GetChildren&lt;TSpecificApiType&gt;()ComputeExecute the Compute command on the objectvoid Compute()PublishParameterPublish or un-publish a number attribute as driving parametervoid PublishParameter(string fieldName, bool trueToPublish)PublishAllParametersToWorkbenchCall this method to expose all object's attributes so that they can be accessible and driven from Workbench.void PublishAllParametersToWorkbench(bool trueToPublish)ApplyPresetUpdate the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error.void ApplyPreset(string presetFilePath)ExportToPresetExport the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error.string ExportToPreset(string filePath)### Property

NameDescriptionSyntaxStyleChild CustomObject attributeSpeosDes.OpticalFeatureStyleCircular StyleGeneralChild CustomObject attributeSpeosDes.OpticalFeatureGeneral GeneralGroupsChildren CustomObjects attributeSpeosDes.CircularSurface.CircularSurfaceGroups GroupsManufacturingChild CustomObject attributeSpeosDes.OpticalFeatureManufacturing ManufacturingExcelFileFile attributeFou.Utils.ValueObjects.FilePath ExcelFileExcelFileFullPathFile attribute (absolute full path)string ExcelFileFullPathSubjectDeprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapperSpaceClaim.Api.V242.CustomObject SubjectOccurrenceGet the underlying CustomObject occurrence, associated to the API object wrapper in current API versionobject OccurrenceNameGet or Set the name of the objectstring NameVisibleChange the visibility status (same behavior as checking/unchecking on the tree view item)bool VisibleStatusInfoGet the status of the object (warning or error message)string StatusInfoIsUpToDateAsk if the object was modified since its last successful computationbool IsUpToDate### CircularSurface.CircularSurfaceGroups

### Method

NameDescriptionSyntaxGetEnumeratorGet children CustomObjects enumerationIEnumerator&lt;SpeosDes.OpticalGroup&gt; GetEnumerator()AddNewCreate a new child CustomObjectSpeosDes.OpticalGroup AddNew(int insertIndex)DeleteDelete a child CustomObject by indexvoid Delete(int index)### Property

NameDescriptionSyntaxCountGet children CustomObjects countint CountListGet children CustomObjects listIReadOnlyCollection&lt;SpeosDes.OpticalGroup&gt; ListItemGet child CustomObject by indexSpeosDes.OpticalGroup ItemItemGet child CustomObject by indexSpeosDes.OpticalGroup Item## ControlPlane

### Static method

NameDescriptionSyntaxCreateCreate a new object of this typeSpeosDes.ControlPlane Create()### Method

NameDescriptionSyntaxToStringstring ToString()### Property

NameDescriptionSyntaxPositionNumber attributedouble PositionPositionTextNumber attribute (as text)string PositionTextDefocusNumber attributedouble DefocusDefocusTextNumber attribute (as text)string DefocusTextHorizontalSpreadNumber attributedouble HorizontalSpreadHorizontalSpreadTextNumber attribute (as text)string HorizontalSpreadTextVerticalOrientationNumber attributedouble VerticalOrientationVerticalOrientationTextNumber attribute (as text)string VerticalOrientationTextVerticalSpreadNumber attributedouble VerticalSpreadVerticalSpreadTextNumber attribute (as text)string VerticalSpreadTextTiltNumber attributedouble TiltTiltTextNumber attribute (as text)string TiltText## ControlPointConfiguration

### Static method

NameDescriptionSyntaxCreateCreate a new object of this typeSpeosDes.ControlPointConfiguration Create()### Method

NameDescriptionSyntaxToStringstring ToString()### Property

NameDescriptionSyntaxPositionNumber attributedouble PositionPositionTextNumber attribute (as text)string PositionTextValueNumber attributedouble ValueValueTextNumber attribute (as text)string ValueText## EyeboxConfiguration

### Static method

NameDescriptionSyntaxCreateCreate a new object of this typeSpeosDes.EyeboxConfiguration Create()### Method

NameDescriptionSyntaxToStringstring ToString()### Property

NameDescriptionSyntaxEBConfigNameString attributestring EBConfigNameOffsetNumber attributedouble OffsetOffsetTextNumber attribute (as text)string OffsetTextWeightNumber attributedouble WeightWeightTextNumber attribute (as text)string WeightText## FreeformLens

### Static method

NameDescriptionSyntaxFromSelectionConvert Items of a ScriptSelection to a list of Speos objects when their type is matching.IEnumerable&lt;SpeosDes.FreeformLens&gt; FromSelection(IEnumerable&lt;SpaceClaim.Api.V242.IDocObject&gt; selectionItems)FindReturns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.\*")SpeosDes.FreeformLens Find(string objectName)CreateCreate a new object of this type under the specified parent componentSpeosDes.FreeformLens Create(object parent)CreateCreate a new object in the active contextSpeosDes.FreeformLens Create()### Method

NameDescriptionSyntaxCloneCreate a copy of this object in the active contextSpeosDes.FreeformLens Clone()CopyToCreate a copy of this object and paste it to the specified destinationSpeosDes.FreeformLens CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)FindOccurrenceInActivePartSearch for occurrences of this object in the active Partobject FindOccurrenceInActivePart()FindOccurrenceInContextOfSearch for occurrences of this object in the specified PartSpaceClaim.Api.V242.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V242.IDocObject contextObject)ToStringGet a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable)string ToString()DeleteDelete this objectbool Delete()GetChildSubjectsRetrieve all children as DocObjectsIEnumerable&lt;SpaceClaim.Api.V242.CustomObject&gt; GetChildSubjects()GetChildrenRetrieve all direct children of a given typeIEnumerable&lt;TSpecificApiType&gt; GetChildren&lt;TSpecificApiType&gt;()ComputeExecute the Compute command on the objectvoid Compute()PublishParameterPublish or un-publish a number attribute as driving parametervoid PublishParameter(string fieldName, bool trueToPublish)PublishAllParametersToWorkbenchCall this method to expose all object's attributes so that they can be accessible and driven from Workbench.void PublishAllParametersToWorkbench(bool trueToPublish)ApplyPresetUpdate the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error.void ApplyPreset(string presetFilePath)ExportToPresetExport the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error.string ExportToPreset(string filePath)### Property

NameDescriptionSyntaxConstructionTypeEnum attributeSpeosDes.FreeformLens.EnumConstructionType ConstructionTypeConstructionTypeIndexEnum attribute (as index)int ConstructionTypeIndexFocalPointLink attributeSpeosDes.FreeformLens.FreeformLensFocalPoint FocalPointOpticalAxisLink attributeSpeosDes.FreeformLens.FreeformLensOpticalAxis OpticalAxisReverseDirectionBoolean attributebool ReverseDirectionRefractiveIndexNumber attributedouble RefractiveIndexRefractiveIndexTextNumber attribute (as text)string RefractiveIndexTextFrontFaceLink attributeSpeosDes.FreeformLens.FreeformLensFrontFace FrontFaceThicknessNumber attributedouble ThicknessThicknessTextNumber attribute (as text)string ThicknessTextTargetDefinitionTypeEnum attributeSpeosDes.FreeformLens.EnumTargetDefinitionType TargetDefinitionTypeTargetDefinitionTypeIndexEnum attribute (as index)int TargetDefinitionTypeIndexTargetOriginLink attributeSpeosDes.FreeformLens.FreeformLensTargetOrigin TargetOriginTargetXAxisLink attributeSpeosDes.FreeformLens.FreeformLensTargetXAxis TargetXAxisTargetYAxisLink attributeSpeosDes.FreeformLens.FreeformLensTargetYAxis TargetYAxisIntensityOpticalAxisLink attributeSpeosDes.FreeformLens.FreeformLensIntensityOpticalAxis IntensityOpticalAxisReverseIntensityOpticalAxisDirectionBoolean attributebool ReverseIntensityOpticalAxisDirectionIntensityOrientationAxisLink attributeSpeosDes.FreeformLens.FreeformLensIntensityOrientationAxis IntensityOrientationAxisReverseIntensityOrientationAxisDirectionBoolean attributebool ReverseIntensityOrientationAxisDirectionTargetTypeEnum attributeSpeosDes.FreeformLens.EnumTargetType TargetTypeTargetTypeIndexEnum attribute (as index)int TargetTypeIndexXTargetMaxNumber attributedouble XTargetMaxXTargetMaxTextNumber attribute (as text)string XTargetMaxTextYTargetMaxNumber attributedouble YTargetMaxYTargetMaxTextNumber attribute (as text)string YTargetMaxTextXTargetGaussianNumber attributedouble XTargetGaussianXTargetGaussianTextNumber attribute (as text)string XTargetGaussianTextYTargetGaussianNumber attributedouble YTargetGaussianYTargetGaussianTextNumber attribute (as text)string YTargetGaussianTextImageFilePathFile attributestring ImageFilePathImageFilePathFullPathFile attribute (absolute full path)string ImageFilePathFullPathTargetTypeIntensityEnum attributeSpeosDes.FreeformLens.EnumTargetTypeIntensity TargetTypeIntensityTargetTypeIntensityIndexEnum attribute (as index)int TargetTypeIntensityIndexIntensityXHalfSpreadNumber attributedouble IntensityXHalfSpreadIntensityXHalfSpreadTextNumber attribute (as text)string IntensityXHalfSpreadTextIntensityYHalfSpreadNumber attributedouble IntensityYHalfSpreadIntensityYHalfSpreadTextNumber attribute (as text)string IntensityYHalfSpreadTextIntensityXFWHMGaussianNumber attributedouble IntensityXFWHMGaussianIntensityXFWHMGaussianTextNumber attribute (as text)string IntensityXFWHMGaussianTextIntensityYFWHMGaussianNumber attributedouble IntensityYFWHMGaussianIntensityYFWHMGaussianTextNumber attribute (as text)string IntensityYFWHMGaussianTextIntensityFilePathFile attributestring IntensityFilePathIntensityFilePathFullPathFile attribute (absolute full path)string IntensityFilePathFullPathImageContrastNumber attributeint ImageContrastImageContrastTextNumber attribute (as text)string ImageContrastTextResolutionFactorNumber attributeint ResolutionFactorResolutionFactorTextNumber attribute (as text)string ResolutionFactorTextThresholdNumber attributeint ThresholdThresholdTextNumber attribute (as text)string ThresholdTextSubjectDeprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapperSpaceClaim.Api.V242.CustomObject SubjectOccurrenceGet the underlying CustomObject occurrence, associated to the API object wrapper in current API versionobject OccurrenceNameGet or Set the name of the objectstring NameVisibleChange the visibility status (same behavior as checking/unchecking on the tree view item)bool VisibleStatusInfoGet the status of the object (warning or error message)string StatusInfoIsUpToDateAsk if the object was modified since its last successful computationbool IsUpToDate### FreeformLens.FreeformLensFocalPoint

### Method

NameDescriptionSyntaxSetLink attribute: Set the link to a script objectbool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)SetLink attribute: Set the link to a DocObjectbool Set(SpaceClaim.Api.V242.IDocObject selectedObject)SetLink attribute: Set the link to an object (IDocObject type from unspecified version)bool Set(object docObjectFromPreviousVersion)ClearLink attribute: Clear the linkvoid Clear()### Property

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed objectSpaceClaim.Api.V242.IDocObject LinkedObject### FreeformLens.FreeformLensOpticalAxis

### Method

NameDescriptionSyntaxSetLink attribute: Set the link to a script objectbool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)SetLink attribute: Set the link to a DocObjectbool Set(SpaceClaim.Api.V242.IDocObject selectedObject)SetLink attribute: Set the link to an object (IDocObject type from unspecified version)bool Set(object docObjectFromPreviousVersion)ClearLink attribute: Clear the linkvoid Clear()### Property

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed objectSpaceClaim.Api.V242.IDocObject LinkedObject### FreeformLens.FreeformLensFrontFace

### Method

NameDescriptionSyntaxSetLink attribute: Set the link to a script objectbool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)SetLink attribute: Set the link to a DocObjectbool Set(SpaceClaim.Api.V242.IDocObject selectedObject)SetLink attribute: Set the link to an object (IDocObject type from unspecified version)bool Set(object docObjectFromPreviousVersion)ClearLink attribute: Clear the linkvoid Clear()### Property

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed objectSpaceClaim.Api.V242.IDocObject LinkedObject### FreeformLens.FreeformLensTargetOrigin

### Method

NameDescriptionSyntaxSetLink attribute: Set the link to a script objectbool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)SetLink attribute: Set the link to a DocObjectbool Set(SpaceClaim.Api.V242.IDocObject selectedObject)SetLink attribute: Set the link to an object (IDocObject type from unspecified version)bool Set(object docObjectFromPreviousVersion)ClearLink attribute: Clear the linkvoid Clear()### Property

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed objectSpaceClaim.Api.V242.IDocObject LinkedObject### FreeformLens.FreeformLensTargetXAxis

### Method

NameDescriptionSyntaxSetLink attribute: Set the link to a script objectbool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)SetLink attribute: Set the link to a DocObjectbool Set(SpaceClaim.Api.V242.IDocObject selectedObject)SetLink attribute: Set the link to an object (IDocObject type from unspecified version)bool Set(object docObjectFromPreviousVersion)ClearLink attribute: Clear the linkvoid Clear()### Property

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed objectSpaceClaim.Api.V242.IDocObject LinkedObject### FreeformLens.FreeformLensTargetYAxis

### Method

NameDescriptionSyntaxSetLink attribute: Set the link to a script objectbool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)SetLink attribute: Set the link to a DocObjectbool Set(SpaceClaim.Api.V242.IDocObject selectedObject)SetLink attribute: Set the link to an object (IDocObject type from unspecified version)bool Set(object docObjectFromPreviousVersion)ClearLink attribute: Clear the linkvoid Clear()### Property

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed objectSpaceClaim.Api.V242.IDocObject LinkedObject### FreeformLens.FreeformLensIntensityOpticalAxis

### Method

NameDescriptionSyntaxSetLink attribute: Set the link to a script objectbool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)SetLink attribute: Set the link to a DocObjectbool Set(SpaceClaim.Api.V242.IDocObject selectedObject)SetLink attribute: Set the link to an object (IDocObject type from unspecified version)bool Set(object docObjectFromPreviousVersion)ClearLink attribute: Clear the linkvoid Clear()### Property

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed objectSpaceClaim.Api.V242.IDocObject LinkedObject### FreeformLens.FreeformLensIntensityOrientationAxis

### Method

NameDescriptionSyntaxSetLink attribute: Set the link to a script objectbool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)SetLink attribute: Set the link to a DocObjectbool Set(SpaceClaim.Api.V242.IDocObject selectedObject)SetLink attribute: Set the link to an object (IDocObject type from unspecified version)bool Set(object docObjectFromPreviousVersion)ClearLink attribute: Clear the linkvoid Clear()### Property

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed objectSpaceClaim.Api.V242.IDocObject LinkedObject## FreestyleCircularLens

### Static method

NameDescriptionSyntaxFromSelectionConvert Items of a ScriptSelection to a list of Speos objects when their type is matching.IEnumerable&lt;SpeosDes.FreestyleCircularLens&gt; FromSelection(IEnumerable&lt;SpaceClaim.Api.V242.IDocObject&gt; selectionItems)FindReturns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.\*")SpeosDes.FreestyleCircularLens Find(string objectName)CreateCreate a new object of this type under the specified parent componentSpeosDes.FreestyleCircularLens Create(object parent)CreateCreate a new object in the active contextSpeosDes.FreestyleCircularLens Create()### Method

NameDescriptionSyntaxCloneCreate a copy of this object in the active contextSpeosDes.FreestyleCircularLens Clone()CopyToCreate a copy of this object and paste it to the specified destinationSpeosDes.FreestyleCircularLens CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)AddGroupCall the 'AddGroup' command.void AddGroup()FindOccurrenceInActivePartSearch for occurrences of this object in the active Partobject FindOccurrenceInActivePart()FindOccurrenceInContextOfSearch for occurrences of this object in the specified PartSpaceClaim.Api.V242.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V242.IDocObject contextObject)ToStringGet a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable)string ToString()DeleteDelete this objectbool Delete()GetChildSubjectsRetrieve all children as DocObjectsIEnumerable&lt;SpaceClaim.Api.V242.CustomObject&gt; GetChildSubjects()GetChildrenRetrieve all direct children of a given typeIEnumerable&lt;TSpecificApiType&gt; GetChildren&lt;TSpecificApiType&gt;()ComputeExecute the Compute command on the objectvoid Compute()PublishParameterPublish or un-publish a number attribute as driving parametervoid PublishParameter(string fieldName, bool trueToPublish)PublishAllParametersToWorkbenchCall this method to expose all object's attributes so that they can be accessible and driven from Workbench.void PublishAllParametersToWorkbench(bool trueToPublish)ApplyPresetUpdate the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error.void ApplyPreset(string presetFilePath)ExportToPresetExport the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error.string ExportToPreset(string filePath)### Property

NameDescriptionSyntaxStyleChild CustomObject attributeSpeosDes.OpticalFeatureStyleFreestyle StyleGeneralChild CustomObject attributeSpeosDes.OpticalFeatureGeneral GeneralGroupsChildren CustomObjects attributeSpeosDes.FreestyleCircularLens.FreestyleCircularLensGroups GroupsManufacturingChild CustomObject attributeSpeosDes.OpticalFeatureManufacturing ManufacturingExcelFileFile attributeFou.Utils.ValueObjects.FilePath ExcelFileExcelFileFullPathFile attribute (absolute full path)string ExcelFileFullPathSubjectDeprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapperSpaceClaim.Api.V242.CustomObject SubjectOccurrenceGet the underlying CustomObject occurrence, associated to the API object wrapper in current API versionobject OccurrenceNameGet or Set the name of the objectstring NameVisibleChange the visibility status (same behavior as checking/unchecking on the tree view item)bool VisibleStatusInfoGet the status of the object (warning or error message)string StatusInfoIsUpToDateAsk if the object was modified since its last successful computationbool IsUpToDate### FreestyleCircularLens.FreestyleCircularLensGroups

### Method

NameDescriptionSyntaxGetEnumeratorGet children CustomObjects enumerationIEnumerator&lt;SpeosDes.OpticalGroup&gt; GetEnumerator()AddNewCreate a new child CustomObjectSpeosDes.OpticalGroup AddNew(int insertIndex)DeleteDelete a child CustomObject by indexvoid Delete(int index)### Property

NameDescriptionSyntaxCountGet children CustomObjects countint CountListGet children CustomObjects listIReadOnlyCollection&lt;SpeosDes.OpticalGroup&gt; ListItemGet child CustomObject by indexSpeosDes.OpticalGroup ItemItemGet child CustomObject by indexSpeosDes.OpticalGroup Item## FreestyleCircularSurface

### Static method

NameDescriptionSyntaxFromSelectionConvert Items of a ScriptSelection to a list of Speos objects when their type is matching.IEnumerable&lt;SpeosDes.FreestyleCircularSurface&gt; FromSelection(IEnumerable&lt;SpaceClaim.Api.V242.IDocObject&gt; selectionItems)FindReturns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.\*")SpeosDes.FreestyleCircularSurface Find(string objectName)CreateCreate a new object of this type under the specified parent componentSpeosDes.FreestyleCircularSurface Create(object parent)CreateCreate a new object in the active contextSpeosDes.FreestyleCircularSurface Create()### Method

NameDescriptionSyntaxCloneCreate a copy of this object in the active contextSpeosDes.FreestyleCircularSurface Clone()CopyToCreate a copy of this object and paste it to the specified destinationSpeosDes.FreestyleCircularSurface CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)AddGroupCall the 'AddGroup' command.void AddGroup()FindOccurrenceInActivePartSearch for occurrences of this object in the active Partobject FindOccurrenceInActivePart()FindOccurrenceInContextOfSearch for occurrences of this object in the specified PartSpaceClaim.Api.V242.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V242.IDocObject contextObject)ToStringGet a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable)string ToString()DeleteDelete this objectbool Delete()GetChildSubjectsRetrieve all children as DocObjectsIEnumerable&lt;SpaceClaim.Api.V242.CustomObject&gt; GetChildSubjects()GetChildrenRetrieve all direct children of a given typeIEnumerable&lt;TSpecificApiType&gt; GetChildren&lt;TSpecificApiType&gt;()ComputeExecute the Compute command on the objectvoid Compute()PublishParameterPublish or un-publish a number attribute as driving parametervoid PublishParameter(string fieldName, bool trueToPublish)PublishAllParametersToWorkbenchCall this method to expose all object's attributes so that they can be accessible and driven from Workbench.void PublishAllParametersToWorkbench(bool trueToPublish)ApplyPresetUpdate the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error.void ApplyPreset(string presetFilePath)ExportToPresetExport the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error.string ExportToPreset(string filePath)### Property

NameDescriptionSyntaxStyleChild CustomObject attributeSpeosDes.OpticalFeatureStyleFreestyle StyleGeneralChild CustomObject attributeSpeosDes.OpticalFeatureGeneral GeneralGroupsChildren CustomObjects attributeSpeosDes.FreestyleCircularSurface.FreestyleCircularSurfaceGroups GroupsManufacturingChild CustomObject attributeSpeosDes.OpticalFeatureManufacturing ManufacturingExcelFileFile attributeFou.Utils.ValueObjects.FilePath ExcelFileExcelFileFullPathFile attribute (absolute full path)string ExcelFileFullPathSubjectDeprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapperSpaceClaim.Api.V242.CustomObject SubjectOccurrenceGet the underlying CustomObject occurrence, associated to the API object wrapper in current API versionobject OccurrenceNameGet or Set the name of the objectstring NameVisibleChange the visibility status (same behavior as checking/unchecking on the tree view item)bool VisibleStatusInfoGet the status of the object (warning or error message)string StatusInfoIsUpToDateAsk if the object was modified since its last successful computationbool IsUpToDate### FreestyleCircularSurface.FreestyleCircularSurfaceGroups

### Method

NameDescriptionSyntaxGetEnumeratorGet children CustomObjects enumerationIEnumerator&lt;SpeosDes.OpticalGroup&gt; GetEnumerator()AddNewCreate a new child CustomObjectSpeosDes.OpticalGroup AddNew(int insertIndex)DeleteDelete a child CustomObject by indexvoid Delete(int index)### Property

NameDescriptionSyntaxCountGet children CustomObjects countint CountListGet children CustomObjects listIReadOnlyCollection&lt;SpeosDes.OpticalGroup&gt; ListItemGet child CustomObject by indexSpeosDes.OpticalGroup ItemItemGet child CustomObject by indexSpeosDes.OpticalGroup Item## FreestyleRectangularLens

### Static method

NameDescriptionSyntaxFromSelectionConvert Items of a ScriptSelection to a list of Speos objects when their type is matching.IEnumerable&lt;SpeosDes.FreestyleRectangularLens&gt; FromSelection(IEnumerable&lt;SpaceClaim.Api.V242.IDocObject&gt; selectionItems)FindReturns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.\*")SpeosDes.FreestyleRectangularLens Find(string objectName)CreateCreate a new object of this type under the specified parent componentSpeosDes.FreestyleRectangularLens Create(object parent)CreateCreate a new object in the active contextSpeosDes.FreestyleRectangularLens Create()### Method

NameDescriptionSyntaxCloneCreate a copy of this object in the active contextSpeosDes.FreestyleRectangularLens Clone()CopyToCreate a copy of this object and paste it to the specified destinationSpeosDes.FreestyleRectangularLens CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)AddGroupCall the 'AddGroup' command.void AddGroup()FindOccurrenceInActivePartSearch for occurrences of this object in the active Partobject FindOccurrenceInActivePart()FindOccurrenceInContextOfSearch for occurrences of this object in the specified PartSpaceClaim.Api.V242.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V242.IDocObject contextObject)ToStringGet a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable)string ToString()DeleteDelete this objectbool Delete()GetChildSubjectsRetrieve all children as DocObjectsIEnumerable&lt;SpaceClaim.Api.V242.CustomObject&gt; GetChildSubjects()GetChildrenRetrieve all direct children of a given typeIEnumerable&lt;TSpecificApiType&gt; GetChildren&lt;TSpecificApiType&gt;()ComputeExecute the Compute command on the objectvoid Compute()PublishParameterPublish or un-publish a number attribute as driving parametervoid PublishParameter(string fieldName, bool trueToPublish)PublishAllParametersToWorkbenchCall this method to expose all object's attributes so that they can be accessible and driven from Workbench.void PublishAllParametersToWorkbench(bool trueToPublish)ApplyPresetUpdate the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error.void ApplyPreset(string presetFilePath)ExportToPresetExport the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error.string ExportToPreset(string filePath)### Property

NameDescriptionSyntaxStyleChild CustomObject attributeSpeosDes.OpticalFeatureStyleFreestyle StyleGeneralChild CustomObject attributeSpeosDes.OpticalFeatureGeneral GeneralGroupsChildren CustomObjects attributeSpeosDes.FreestyleRectangularLens.FreestyleRectangularLensGroups GroupsManufacturingChild CustomObject attributeSpeosDes.OpticalFeatureManufacturing ManufacturingExcelFileFile attributeFou.Utils.ValueObjects.FilePath ExcelFileExcelFileFullPathFile attribute (absolute full path)string ExcelFileFullPathSubjectDeprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapperSpaceClaim.Api.V242.CustomObject SubjectOccurrenceGet the underlying CustomObject occurrence, associated to the API object wrapper in current API versionobject OccurrenceNameGet or Set the name of the objectstring NameVisibleChange the visibility status (same behavior as checking/unchecking on the tree view item)bool VisibleStatusInfoGet the status of the object (warning or error message)string StatusInfoIsUpToDateAsk if the object was modified since its last successful computationbool IsUpToDate### FreestyleRectangularLens.FreestyleRectangularLensGroups

### Method

NameDescriptionSyntaxGetEnumeratorGet children CustomObjects enumerationIEnumerator&lt;SpeosDes.OpticalGroup&gt; GetEnumerator()AddNewCreate a new child CustomObjectSpeosDes.OpticalGroup AddNew(int insertIndex)DeleteDelete a child CustomObject by indexvoid Delete(int index)### Property

NameDescriptionSyntaxCountGet children CustomObjects countint CountListGet children CustomObjects listIReadOnlyCollection&lt;SpeosDes.OpticalGroup&gt; ListItemGet child CustomObject by indexSpeosDes.OpticalGroup ItemItemGet child CustomObject by indexSpeosDes.OpticalGroup Item## FreestyleRectangularSurface

### Static method

NameDescriptionSyntaxFromSelectionConvert Items of a ScriptSelection to a list of Speos objects when their type is matching.IEnumerable&lt;SpeosDes.FreestyleRectangularSurface&gt; FromSelection(IEnumerable&lt;SpaceClaim.Api.V242.IDocObject&gt; selectionItems)FindReturns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.\*")SpeosDes.FreestyleRectangularSurface Find(string objectName)CreateCreate a new object of this type under the specified parent componentSpeosDes.FreestyleRectangularSurface Create(object parent)CreateCreate a new object in the active contextSpeosDes.FreestyleRectangularSurface Create()### Method

NameDescriptionSyntaxCloneCreate a copy of this object in the active contextSpeosDes.FreestyleRectangularSurface Clone()CopyToCreate a copy of this object and paste it to the specified destinationSpeosDes.FreestyleRectangularSurface CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)AddGroupCall the 'AddGroup' command.void AddGroup()FindOccurrenceInActivePartSearch for occurrences of this object in the active Partobject FindOccurrenceInActivePart()FindOccurrenceInContextOfSearch for occurrences of this object in the specified PartSpaceClaim.Api.V242.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V242.IDocObject contextObject)ToStringGet a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable)string ToString()DeleteDelete this objectbool Delete()GetChildSubjectsRetrieve all children as DocObjectsIEnumerable&lt;SpaceClaim.Api.V242.CustomObject&gt; GetChildSubjects()GetChildrenRetrieve all direct children of a given typeIEnumerable&lt;TSpecificApiType&gt; GetChildren&lt;TSpecificApiType&gt;()ComputeExecute the Compute command on the objectvoid Compute()PublishParameterPublish or un-publish a number attribute as driving parametervoid PublishParameter(string fieldName, bool trueToPublish)PublishAllParametersToWorkbenchCall this method to expose all object's attributes so that they can be accessible and driven from Workbench.void PublishAllParametersToWorkbench(bool trueToPublish)ApplyPresetUpdate the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error.void ApplyPreset(string presetFilePath)ExportToPresetExport the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error.string ExportToPreset(string filePath)### Property

NameDescriptionSyntaxStyleChild CustomObject attributeSpeosDes.OpticalFeatureStyleFreestyle StyleGeneralChild CustomObject attributeSpeosDes.OpticalFeatureGeneral GeneralGroupsChildren CustomObjects attributeSpeosDes.FreestyleRectangularSurface.FreestyleRectangularSurfaceGroups GroupsManufacturingChild CustomObject attributeSpeosDes.OpticalFeatureManufacturing ManufacturingExcelFileFile attributeFou.Utils.ValueObjects.FilePath ExcelFileExcelFileFullPathFile attribute (absolute full path)string ExcelFileFullPathSubjectDeprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapperSpaceClaim.Api.V242.CustomObject SubjectOccurrenceGet the underlying CustomObject occurrence, associated to the API object wrapper in current API versionobject OccurrenceNameGet or Set the name of the objectstring NameVisibleChange the visibility status (same behavior as checking/unchecking on the tree view item)bool VisibleStatusInfoGet the status of the object (warning or error message)string StatusInfoIsUpToDateAsk if the object was modified since its last successful computationbool IsUpToDate### FreestyleRectangularSurface.FreestyleRectangularSurfaceGroups

### Method

NameDescriptionSyntaxGetEnumeratorGet children CustomObjects enumerationIEnumerator&lt;SpeosDes.OpticalGroup&gt; GetEnumerator()AddNewCreate a new child CustomObjectSpeosDes.OpticalGroup AddNew(int insertIndex)DeleteDelete a child CustomObject by indexvoid Delete(int index)### Property

NameDescriptionSyntaxCountGet children CustomObjects countint CountListGet children CustomObjects listIReadOnlyCollection&lt;SpeosDes.OpticalGroup&gt; ListItemGet child CustomObject by indexSpeosDes.OpticalGroup ItemItemGet child CustomObject by indexSpeosDes.OpticalGroup Item## HoneycombLens

### Static method

NameDescriptionSyntaxFromSelectionConvert Items of a ScriptSelection to a list of Speos objects when their type is matching.IEnumerable&lt;SpeosDes.HoneycombLens&gt; FromSelection(IEnumerable&lt;SpaceClaim.Api.V242.IDocObject&gt; selectionItems)FindReturns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.\*")SpeosDes.HoneycombLens Find(string objectName)CreateCreate a new object of this type under the specified parent componentSpeosDes.HoneycombLens Create(object parent)CreateCreate a new object in the active contextSpeosDes.HoneycombLens Create()### Method

NameDescriptionSyntaxCloneCreate a copy of this object in the active contextSpeosDes.HoneycombLens Clone()CopyToCreate a copy of this object and paste it to the specified destinationSpeosDes.HoneycombLens CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)AddGroupCall the 'AddGroup' command.void AddGroup()FindOccurrenceInActivePartSearch for occurrences of this object in the active Partobject FindOccurrenceInActivePart()FindOccurrenceInContextOfSearch for occurrences of this object in the specified PartSpaceClaim.Api.V242.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V242.IDocObject contextObject)ToStringGet a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable)string ToString()DeleteDelete this objectbool Delete()GetChildSubjectsRetrieve all children as DocObjectsIEnumerable&lt;SpaceClaim.Api.V242.CustomObject&gt; GetChildSubjects()GetChildrenRetrieve all direct children of a given typeIEnumerable&lt;TSpecificApiType&gt; GetChildren&lt;TSpecificApiType&gt;()ComputeExecute the Compute command on the objectvoid Compute()PublishParameterPublish or un-publish a number attribute as driving parametervoid PublishParameter(string fieldName, bool trueToPublish)PublishAllParametersToWorkbenchCall this method to expose all object's attributes so that they can be accessible and driven from Workbench.void PublishAllParametersToWorkbench(bool trueToPublish)ApplyPresetUpdate the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error.void ApplyPreset(string presetFilePath)ExportToPresetExport the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error.string ExportToPreset(string filePath)### Property

NameDescriptionSyntaxStyleChild CustomObject attributeSpeosDes.OpticalFeatureStyleHoneycomb StyleGeneralChild CustomObject attributeSpeosDes.OpticalFeatureGeneral GeneralGroupsChildren CustomObjects attributeSpeosDes.HoneycombLens.HoneycombLensGroups GroupsManufacturingChild CustomObject attributeSpeosDes.OpticalFeatureManufacturing ManufacturingExcelFileFile attributeFou.Utils.ValueObjects.FilePath ExcelFileExcelFileFullPathFile attribute (absolute full path)string ExcelFileFullPathSubjectDeprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapperSpaceClaim.Api.V242.CustomObject SubjectOccurrenceGet the underlying CustomObject occurrence, associated to the API object wrapper in current API versionobject OccurrenceNameGet or Set the name of the objectstring NameVisibleChange the visibility status (same behavior as checking/unchecking on the tree view item)bool VisibleStatusInfoGet the status of the object (warning or error message)string StatusInfoIsUpToDateAsk if the object was modified since its last successful computationbool IsUpToDate### HoneycombLens.HoneycombLensGroups

### Method

NameDescriptionSyntaxGetEnumeratorGet children CustomObjects enumerationIEnumerator&lt;SpeosDes.OpticalGroup&gt; GetEnumerator()AddNewCreate a new child CustomObjectSpeosDes.OpticalGroup AddNew(int insertIndex)DeleteDelete a child CustomObject by indexvoid Delete(int index)### Property

NameDescriptionSyntaxCountGet children CustomObjects countint CountListGet children CustomObjects listIReadOnlyCollection&lt;SpeosDes.OpticalGroup&gt; ListItemGet child CustomObject by indexSpeosDes.OpticalGroup ItemItemGet child CustomObject by indexSpeosDes.OpticalGroup Item## HUDOD

### Static method

NameDescriptionSyntaxFromSelectionConvert Items of a ScriptSelection to a list of Speos objects when their type is matching.IEnumerable&lt;SpeosDes.HUDOD&gt; FromSelection(IEnumerable&lt;SpaceClaim.Api.V242.IDocObject&gt; selectionItems)FindReturns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.\*")SpeosDes.HUDOD Find(string objectName)CreateCreate a new object of this type under the specified parent componentSpeosDes.HUDOD Create(object parent)CreateCreate a new object in the active contextSpeosDes.HUDOD Create()### Method

NameDescriptionSyntaxCloneCreate a copy of this object in the active contextSpeosDes.HUDOD Clone()CopyToCreate a copy of this object and paste it to the specified destinationSpeosDes.HUDOD CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)UpdateAdvancedParametersCall the 'Update all parameters' command. Returns 'false' if this action is unavailable in the current state of the object.bool UpdateAdvancedParameters()GetResultFilePathsGet the list of paths of all HUD Optical Design resulting filesSystem.String\[\] GetResultFilePaths()FindOccurrenceInActivePartSearch for occurrences of this object in the active Partobject FindOccurrenceInActivePart()FindOccurrenceInContextOfSearch for occurrences of this object in the specified PartSpaceClaim.Api.V242.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V242.IDocObject contextObject)ToStringGet a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable)string ToString()DeleteDelete this objectbool Delete()GetChildSubjectsRetrieve all children as DocObjectsIEnumerable&lt;SpaceClaim.Api.V242.CustomObject&gt; GetChildSubjects()GetChildrenRetrieve all direct children of a given typeIEnumerable&lt;TSpecificApiType&gt; GetChildren&lt;TSpecificApiType&gt;()ComputeExecute the Compute command on the objectvoid Compute()PublishParameterPublish or un-publish a number attribute as driving parametervoid PublishParameter(string fieldName, bool trueToPublish)PublishAllParametersToWorkbenchCall this method to expose all object's attributes so that they can be accessible and driven from Workbench.void PublishAllParametersToWorkbench(bool trueToPublish)ApplyPresetUpdate the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error.void ApplyPreset(string presetFilePath)ExportToPresetExport the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error.string ExportToPreset(string filePath)### Property

NameDescriptionSyntaxVehicleAxisLink attributeSpeosDes.HUDOD.HUDODVehicleAxis VehicleAxisReverseVehiculeAxisDirectionBoolean attributebool ReverseVehiculeAxisDirectionTopAxisLink attributeSpeosDes.HUDOD.HUDODTopAxis TopAxisReverseTopAxisDirectionBoolean attributebool ReverseTopAxisDirectionManufacturingXNumber attributeint ManufacturingXManufacturingXTextNumber attribute (as text)string ManufacturingXTextManufacturingYNumber attributeint ManufacturingYManufacturingYTextNumber attribute (as text)string ManufacturingYTextEyeboxCenterLink attributeSpeosDes.HUDOD.HUDODEyeboxCenter EyeboxCenterEyeboxOrientationTypeEnum attributeSpeosDes.HUDOD.EnumEyeboxOrientationType EyeboxOrientationTypeEyeboxOrientationTypeIndexEnum attribute (as index)int EyeboxOrientationTypeIndexEBHorizontalSizeNumber attributedouble EBHorizontalSizeEBHorizontalSizeTextNumber attribute (as text)string EBHorizontalSizeTextEBHorizontalSamplingNumber attributeint EBHorizontalSamplingEBHorizontalSamplingTextNumber attribute (as text)string EBHorizontalSamplingTextEBHorizontalResolutionNumber attributedouble EBHorizontalResolutionEBHorizontalResolutionTextNumber attribute (as text)string EBHorizontalResolutionTextEBVerticalSizeNumber attributedouble EBVerticalSizeEBVerticalSizeTextNumber attribute (as text)string EBVerticalSizeTextEBVerticalSamplingNumber attributeint EBVerticalSamplingEBVerticalSamplingTextNumber attribute (as text)string EBVerticalSamplingTextEBVerticalResolutionNumber attributedouble EBVerticalResolutionEBVerticalResolutionTextNumber attribute (as text)string EBVerticalResolutionTextEyeboxConfigPositionDirectionTypeEnum attributeSpeosDes.HUDOD.EnumEyeboxConfigPositionDirectionType EyeboxConfigPositionDirectionTypeEyeboxConfigPositionDirectionTypeIndexEnum attribute (as index)int EyeboxConfigPositionDirectionTypeIndexEBConfigurationsChildren attributeSpeosDes.HUDOD.HUDODEBConfigurations EBConfigurationsTIVirtualImageDistanceNumber attributedouble TIVirtualImageDistanceTIVirtualImageDistanceTextNumber attribute (as text)string TIVirtualImageDistanceTextTILookOverAngleNumber attributedouble TILookOverAngleTILookOverAngleTextNumber attribute (as text)string TILookOverAngleTextTILookDownAngleNumber attributedouble TILookDownAngleTILookDownAngleTextNumber attribute (as text)string TILookDownAngleTextTargetImageModeTypeEnum attributeSpeosDes.HUDOD.EnumTargetImageModeType TargetImageModeTypeTargetImageModeTypeIndexEnum attribute (as index)int TargetImageModeTypeIndexTIHorizontalSizeNumber attributedouble TIHorizontalSizeTIHorizontalSizeTextNumber attribute (as text)string TIHorizontalSizeTextTIVerticalSizeNumber attributedouble TIVerticalSizeTIVerticalSizeTextNumber attribute (as text)string TIVerticalSizeTextTIHorizontalFOVNumber attributedouble TIHorizontalFOVTIHorizontalFOVTextNumber attribute (as text)string TIHorizontalFOVTextTIVerticalFOVNumber attributedouble TIVerticalFOVTIVerticalFOVTextNumber attribute (as text)string TIVerticalFOVTextWindshieldInnerSurfaceLink attributeSpeosDes.HUDOD.HUDODWindshieldInnerSurface WindshieldInnerSurfaceProjectorsChildren attributeSpeosDes.HUDOD.HUDODProjectors ProjectorsPGUHorizontalSamplingNumber attributeint PGUHorizontalSamplingPGUHorizontalSamplingTextNumber attribute (as text)string PGUHorizontalSamplingTextPGUVerticalSamplingNumber attributeint PGUVerticalSamplingPGUVerticalSamplingTextNumber attribute (as text)string PGUVerticalSamplingTextPGUCharacteristicsTypeEnum attributeSpeosDes.HUDOD.EnumPGUCharacteristicsType PGUCharacteristicsTypePGUCharacteristicsTypeIndexEnum attribute (as index)int PGUCharacteristicsTypeIndexPGUHorizontalSizeNumber attributedouble PGUHorizontalSizePGUHorizontalSizeTextNumber attribute (as text)string PGUHorizontalSizeTextPGUHorizontalResolutionNumber attributeint PGUHorizontalResolutionPGUHorizontalResolutionTextNumber attribute (as text)string PGUHorizontalResolutionTextPGUVerticalSizeNumber attributedouble PGUVerticalSizePGUVerticalSizeTextNumber attribute (as text)string PGUVerticalSizeTextPGUVerticalResolutionNumber attributeint PGUVerticalResolutionPGUVerticalResolutionTextNumber attribute (as text)string PGUVerticalResolutionTextAdvancedParametersAccess the HUD Optical Design dynamic parametersSpeosDes.HUDOD.DynamicParametersAttribute AdvancedParametersSubjectDeprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapperSpaceClaim.Api.V242.CustomObject SubjectOccurrenceGet the underlying CustomObject occurrence, associated to the API object wrapper in current API versionobject OccurrenceNameGet or Set the name of the objectstring NameVisibleChange the visibility status (same behavior as checking/unchecking on the tree view item)bool VisibleStatusInfoGet the status of the object (warning or error message)string StatusInfoIsUpToDateAsk if the object was modified since its last successful computationbool IsUpToDate### HUDOD.HUDODVehicleAxis

### Method

NameDescriptionSyntaxSetLink attribute: Set the link to a script objectbool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)SetLink attribute: Set the link to a DocObjectbool Set(SpaceClaim.Api.V242.IDocObject selectedObject)SetLink attribute: Set the link to an object (IDocObject type from unspecified version)bool Set(object docObjectFromPreviousVersion)ClearLink attribute: Clear the linkvoid Clear()### Property

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed objectSpaceClaim.Api.V242.IDocObject LinkedObject### HUDOD.HUDODTopAxis

### Method

NameDescriptionSyntaxSetLink attribute: Set the link to a script objectbool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)SetLink attribute: Set the link to a DocObjectbool Set(SpaceClaim.Api.V242.IDocObject selectedObject)SetLink attribute: Set the link to an object (IDocObject type from unspecified version)bool Set(object docObjectFromPreviousVersion)ClearLink attribute: Clear the linkvoid Clear()### Property

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed objectSpaceClaim.Api.V242.IDocObject LinkedObject### HUDOD.HUDODEyeboxCenter

### Method

NameDescriptionSyntaxSetLink attribute: Set the link to a script objectbool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)SetLink attribute: Set the link to a DocObjectbool Set(SpaceClaim.Api.V242.IDocObject selectedObject)SetLink attribute: Set the link to an object (IDocObject type from unspecified version)bool Set(object docObjectFromPreviousVersion)ClearLink attribute: Clear the linkvoid Clear()### Property

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed objectSpaceClaim.Api.V242.IDocObject LinkedObject### HUDOD.HUDODEBConfigurations

### Method

NameDescriptionSyntaxSetChildren attribute: Set from an array of script objectsbool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject\[\] selectedObjects)SetChildren attribute: Set from an array of document objectsbool Set(SpaceClaim.Api.V242.IDocObject\[\] selectedObjects)SetChildren attribute: Set from an array of objects (IDocObject type from unspecified version)bool Set(System.Object\[\] docObjectsFromPreviousVersion)GetEnumeratorChildren attribute: Get children enumerationIEnumerator&lt;SpeosDes.EyeboxConfiguration&gt; GetEnumerator()AddNewChildren attribute: Create a new child objectSpeosDes.EyeboxConfiguration AddNew(int insertIndex)DeleteChildren attribute: Delete a child object by indexbool Delete(int index)ClearChildren attribute: Empty the listvoid Clear()SelectAllChildren attribute: Create children for all objects that are compatible with link selection.void SelectAll()### Property

NameDescriptionSyntaxLinkedObjectsChildren attribute: Get linked objectsIReadOnlyCollection&lt;SpaceClaim.Api.V242.IDocObject&gt; LinkedObjectsCountChildren attribute: Get children countint CountListChildren attribute: Get children collectionIReadOnlyCollection&lt;SpeosDes.EyeboxConfiguration&gt; ListItemChildren attribute: Get child by indexSpeosDes.EyeboxConfiguration Item### HUDOD.HUDODWindshieldInnerSurface

### Method

NameDescriptionSyntaxSetLink attribute: Set the link to a script objectbool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)SetLink attribute: Set the link to a DocObjectbool Set(SpaceClaim.Api.V242.IDocObject selectedObject)SetLink attribute: Set the link to an object (IDocObject type from unspecified version)bool Set(object docObjectFromPreviousVersion)ClearLink attribute: Clear the linkvoid Clear()### Property

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed objectSpaceClaim.Api.V242.IDocObject LinkedObject### HUDOD.HUDODProjectors

### Method

NameDescriptionSyntaxSetChildren attribute: Set from an array of script objectsbool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject\[\] selectedObjects)SetChildren attribute: Set from an array of document objectsbool Set(SpaceClaim.Api.V242.IDocObject\[\] selectedObjects)SetChildren attribute: Set from an array of objects (IDocObject type from unspecified version)bool Set(System.Object\[\] docObjectsFromPreviousVersion)GetEnumeratorChildren attribute: Get children enumerationIEnumerator&lt;SpeosDes.HUDProjectorElement&gt; GetEnumerator()AddNewChildren attribute: Create a new child objectSpeosDes.HUDProjectorElement AddNew(int insertIndex)DeleteChildren attribute: Delete a child object by indexbool Delete(int index)ClearChildren attribute: Empty the listvoid Clear()SelectAllChildren attribute: Create children for all objects that are compatible with link selection.void SelectAll()### Property

NameDescriptionSyntaxLinkedObjectsChildren attribute: Get linked objectsIReadOnlyCollection&lt;SpaceClaim.Api.V242.IDocObject&gt; LinkedObjectsCountChildren attribute: Get children countint CountListChildren attribute: Get children collectionIReadOnlyCollection&lt;SpeosDes.HUDProjectorElement&gt; ListItemChildren attribute: Get child by indexSpeosDes.HUDProjectorElement Item### HUDOD.DynamicParametersAttribute

### Method

NameDescriptionSyntaxGetEnumeratorHUD Optical Design dynamic parameters enumeratorIEnumerator GetEnumerator()### Property

NameDescriptionSyntaxItemHUD Optical Design dynamic parameters, get by index operatordouble Item## HUDProjectorElement

### Static method

NameDescriptionSyntaxCreateCreate a new object of this typeSpeosDes.HUDProjectorElement Create()### Method

NameDescriptionSyntaxToStringstring ToString()### Property

NameDescriptionSyntaxNameString attributestring NameProjectorTypeEnum attributeSpeosDes.HUDProjectorElement.EnumProjectorType ProjectorTypeProjectorTypeIndexEnum attribute (as index)int ProjectorTypeIndexDistanceNumber attributedouble DistanceDistanceTextNumber attribute (as text)string DistanceTextHorizontalAngleNumber attributedouble HorizontalAngleHorizontalAngleTextNumber attribute (as text)string HorizontalAngleTextMultiConfigBoolean attributebool MultiConfigVerticalAngleNumber attributedouble VerticalAngleVerticalAngleTextNumber attribute (as text)string VerticalAngleText## LightGuide

### Method

NameDescriptionSyntaxGetStartRadiusTypePossibleValuesString list attribute: List possible valuesIEnumerable GetStartRadiusTypePossibleValues()GetEndRadiusTypePossibleValuesString list attribute: List possible valuesIEnumerable GetEndRadiusTypePossibleValues()GetMillingTypePossibleValuesString list attribute: List possible valuesIEnumerable GetMillingTypePossibleValues()GetBottomPrismMillingTypePossibleValuesString list attribute: List possible valuesIEnumerable GetBottomPrismMillingTypePossibleValues()ExportAsCSVFilevoid ExportAsCSVFile(string csvFilePath)CloneCreate a copy of this object in the active contextSpeosDes.LightGuide Clone()CopyToCreate a copy of this object and paste it to the specified destinationSpeosDes.LightGuide CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)GetStepTypePossibleValuesString list attribute: List possible valuesIEnumerable GetStepTypePossibleValues()GetLengthTypePossibleValuesString list attribute: List possible valuesIEnumerable GetLengthTypePossibleValues()GetTrimmingRatioTypePossibleValuesString list attribute: List possible valuesIEnumerable GetTrimmingRatioTypePossibleValues()GetPeakTrimmingRatioTypePossibleValuesString list attribute: List possible valuesIEnumerable GetPeakTrimmingRatioTypePossibleValues()GetOffsetTypePossibleValuesString list attribute: List possible valuesIEnumerable GetOffsetTypePossibleValues()GetWidthTypePossibleValuesString list attribute: List possible valuesIEnumerable GetWidthTypePossibleValues()GetStartAngleTypePossibleValuesString list attribute: List possible valuesIEnumerable GetStartAngleTypePossibleValues()GetEndAngleTypePossibleValuesString list attribute: List possible valuesIEnumerable GetEndAngleTypePossibleValues()FindOccurrenceInActivePartSearch for occurrences of this object in the active Partobject FindOccurrenceInActivePart()FindOccurrenceInContextOfSearch for occurrences of this object in the specified PartSpaceClaim.Api.V242.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V242.IDocObject contextObject)ToStringGet a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable)string ToString()DeleteDelete this objectbool Delete()GetChildSubjectsRetrieve all children as DocObjectsIEnumerable&lt;SpaceClaim.Api.V242.CustomObject&gt; GetChildSubjects()GetChildrenRetrieve all direct children of a given typeIEnumerable&lt;TSpecificApiType&gt; GetChildren&lt;TSpecificApiType&gt;()ComputeExecute the Compute command on the objectvoid Compute()PublishParameterPublish or un-publish a number attribute as driving parametervoid PublishParameter(string fieldName, bool trueToPublish)PublishAllParametersToWorkbenchCall this method to expose all object's attributes so that they can be accessible and driven from Workbench.void PublishAllParametersToWorkbench(bool trueToPublish)ApplyPresetUpdate the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error.void ApplyPreset(string presetFilePath)ExportToPresetExport the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error.string ExportToPreset(string filePath)### Static method

NameDescriptionSyntaxFromSelectionConvert Items of a ScriptSelection to a list of Speos objects when their type is matching.IEnumerable&lt;SpeosDes.LightGuide&gt; FromSelection(IEnumerable&lt;SpaceClaim.Api.V242.IDocObject&gt; selectionItems)FindReturns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.\*")SpeosDes.LightGuide Find(string objectName)CreateCreate a new object of this type under the specified parent componentSpeosDes.LightGuide Create(object parent)CreateCreate a new object in the active contextSpeosDes.LightGuide Create()### Property

NameDescriptionSyntaxGuideCurveLinks attributeSpeosDes.LightGuide.LightGuideGuideCurve GuideCurveReverseGuideCurveDirectionBoolean attributebool ReverseGuideCurveDirectionMultipleOpticalAxisChildren attributeSpeosDes.LightGuide.LightGuideMultipleOpticalAxis MultipleOpticalAxisBodyTypeEnum attributeSpeosDes.LightGuide.EnumBodyType BodyTypeBodyTypeIndexEnum attribute (as index)int BodyTypeIndexBodyProfileDiameterNumber attributedouble BodyProfileDiameterBodyProfileDiameterTextNumber attribute (as text)string BodyProfileDiameterTextExtraBodyHeightNumber attributedouble ExtraBodyHeightExtraBodyHeightTextNumber attribute (as text)string ExtraBodyHeightTextBodyProfileNumber attributeSpeosDes.LightGuide.LightGuideBodyProfile BodyProfilePrismsOrientationTypeEnum attributeSpeosDes.LightGuide.EnumPrismsOrientationType PrismsOrientationTypePrismsOrientationTypeIndexEnum attribute (as index)int PrismsOrientationTypeIndexOpticalAxisLink attributeSpeosDes.LightGuide.LightGuideOpticalAxis OpticalAxisReverseOpticalAxisDirectionBoolean attributebool ReverseOpticalAxisDirectionOrientationSurfaceLink attributeSpeosDes.LightGuide.LightGuideOrientationSurface OrientationSurfacePrismsOperationTypeEnum attributeSpeosDes.LightGuide.EnumPrismsOperationType PrismsOperationTypePrismsOperationTypeIndexEnum attribute (as index)int PrismsOperationTypeIndexRefractiveIndexNumber attributedouble RefractiveIndexRefractiveIndexTextNumber attribute (as text)string RefractiveIndexTextDistancesTypeEnum attributeSpeosDes.LightGuide.EnumDistancesType DistancesTypeDistancesTypeIndexEnum attribute (as index)int DistancesTypeIndexProjectionAxisLink attributeSpeosDes.LightGuide.LightGuideProjectionAxis ProjectionAxisDistanceStartNumber attributedouble DistanceStartDistanceStartTextNumber attribute (as text)string DistanceStartTextDistanceEndNumber attributedouble DistanceEndDistanceEndTextNumber attribute (as text)string DistanceEndTextStepTypeString list selection attributestring StepTypeStepValueNumber attributedouble StepValueStepValueTextNumber attribute (as text)string StepValueTextStepConfigurationsChildren attributeSpeosDes.LightGuide.LightGuideStepConfigurations StepConfigurationsLengthTypeString list selection attributestring LengthTypeLengthValueNumber attributedouble LengthValueLengthValueTextNumber attribute (as text)string LengthValueTextLengthConfigurationsChildren attributeSpeosDes.LightGuide.LightGuideLengthConfigurations LengthConfigurationsTrimmingRatioTypeString list selection attributestring TrimmingRatioTypeTrimmingRatioValueNumber attributedouble TrimmingRatioValueTrimmingRatioValueTextNumber attribute (as text)string TrimmingRatioValueTextTrimmingRatioConfigurationsChildren attributeSpeosDes.LightGuide.LightGuideTrimmingRatioConfigurations TrimmingRatioConfigurationsPeakTrimmingRatioTypeString list selection attributestring PeakTrimmingRatioTypePeakTrimmingRatioValueNumber attributedouble PeakTrimmingRatioValuePeakTrimmingRatioValueTextNumber attribute (as text)string PeakTrimmingRatioValueTextPeakTrimmingRatioConfigurationsChildren attributeSpeosDes.LightGuide.LightGuidePeakTrimmingRatioConfigurations PeakTrimmingRatioConfigurationsOffsetTypeString list selection attributestring OffsetTypeOffsetValueNumber attributedouble OffsetValueOffsetValueTextNumber attribute (as text)string OffsetValueTextOffsetConfigurationsChildren attributeSpeosDes.LightGuide.LightGuideOffsetConfigurations OffsetConfigurationsWidthTypeString list selection attributestring WidthTypeWidthValueNumber attributedouble WidthValueWidthValueTextNumber attribute (as text)string WidthValueTextWidthConfigurationsChildren attributeSpeosDes.LightGuide.LightGuideWidthConfigurations WidthConfigurationsStartAngleTypeString list selection attributestring StartAngleTypeStartAngleValueNumber attributedouble StartAngleValueStartAngleValueTextNumber attribute (as text)string StartAngleValueTextStartAngleConfigurationsChildren attributeSpeosDes.LightGuide.LightGuideStartAngleConfigurations StartAngleConfigurationsEndAngleTypeString list selection attributestring EndAngleTypeEndAngleValueNumber attributedouble EndAngleValueEndAngleValueTextNumber attribute (as text)string EndAngleValueTextEndAngleConfigurationsChildren attributeSpeosDes.LightGuide.LightGuideEndAngleConfigurations EndAngleConfigurationsStartRadiusTypeString list selection attributestring StartRadiusTypeStartRadiusValueNumber attributedouble StartRadiusValueStartRadiusValueTextNumber attribute (as text)string StartRadiusValueTextStartRadiusConfigurationsChildren attributeSpeosDes.LightGuide.LightGuideStartRadiusConfigurations StartRadiusConfigurationsEndRadiusTypeString list selection attributestring EndRadiusTypeEndRadiusValueNumber attributedouble EndRadiusValueEndRadiusValueTextNumber attribute (as text)string EndRadiusValueTextEndRadiusConfigurationsChildren attributeSpeosDes.LightGuide.LightGuideEndRadiusConfigurations EndRadiusConfigurationsCSVFileFile attributestring CSVFileCSVFileFullPathFile attribute (absolute full path)string CSVFileFullPathMillingTypeString list selection attributestring MillingTypeMillingValueNumber attributedouble MillingValueMillingValueTextNumber attribute (as text)string MillingValueTextMillingConfigurationsChildren attributeSpeosDes.LightGuide.LightGuideMillingConfigurations MillingConfigurationsBottomPrismMillingTypeString list selection attributestring BottomPrismMillingTypeBottomPrismMillingValueNumber attributedouble BottomPrismMillingValueBottomPrismMillingValueTextNumber attribute (as text)string BottomPrismMillingValueTextBottomPrismMillingConfigurationsChildren attributeSpeosDes.LightGuide.LightGuideBottomPrismMillingConfigurations BottomPrismMillingConfigurationsDraftingTypeEnum attributeSpeosDes.LightGuide.EnumDraftingType DraftingTypeDraftingTypeIndexEnum attribute (as index)int DraftingTypeIndexDemoldingOrientationLink attributeSpeosDes.LightGuide.LightGuideDemoldingOrientation DemoldingOrientationReverseDemoldingDirectionBoolean attributebool ReverseDemoldingDirectionDraftAngleNumber attributedouble DraftAngleDraftAngleTextNumber attribute (as text)string DraftAngleTextNbPrismsNumber attributeint NbPrismsNbPrismsTextNumber attribute (as text)string NbPrismsTextSubjectDeprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapperSpaceClaim.Api.V242.CustomObject SubjectOccurrenceGet the underlying CustomObject occurrence, associated to the API object wrapper in current API versionobject OccurrenceNameGet or Set the name of the objectstring NameVisibleChange the visibility status (same behavior as checking/unchecking on the tree view item)bool VisibleStatusInfoGet the status of the object (warning or error message)string StatusInfoIsUpToDateAsk if the object was modified since its last successful computationbool IsUpToDate### LightGuide.LightGuideGuideCurve

### Method

NameDescriptionSyntaxSetLinks attribute: Link to an array of script objectsbool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject\[\] selectedObjects)SetLinks attribute: Link to an array of document objectsbool Set(SpaceClaim.Api.V242.IDocObject\[\] selectedObjects)SetLinks attribute: Link to an array of document objects (IDocObject type from unspecified version)bool Set(System.Object\[\] docObjectsFromPreviousVersion)ClearLinks attribute: Clear the list of linksvoid Clear()SelectAllLinks attribute: Link to all compatible objects in the active contextvoid SelectAll()### Property

NameDescriptionSyntaxLinkedObjectsLinks attribute: Get the pointed document objectsIReadOnlyCollection&lt;SpaceClaim.Api.V242.IDocObject&gt; LinkedObjectsItemLinks attribute: Get a pointed document object by indexSpaceClaim.Api.V242.IDocObject ItemCountLinks attribute: Get the links countint Count### LightGuide.LightGuideMultipleOpticalAxis

### Method

NameDescriptionSyntaxSetChildren attribute: Set from an array of script objectsbool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject\[\] selectedObjects)SetChildren attribute: Set from an array of document objectsbool Set(SpaceClaim.Api.V242.IDocObject\[\] selectedObjects)SetChildren attribute: Set from an array of objects (IDocObject type from unspecified version)bool Set(System.Object\[\] docObjectsFromPreviousVersion)GetEnumeratorChildren attribute: Get children enumerationIEnumerator GetEnumerator()AddNewChildren attribute: Create a new child objectSpeosDes.MultipleOpticalAxis AddNew(int insertIndex)DeleteChildren attribute: Delete a child object by indexbool Delete(int index)ClearChildren attribute: Empty the listvoid Clear()SelectAllChildren attribute: Create children for all objects that are compatible with link selection.void SelectAll()### Property

NameDescriptionSyntaxLinkedObjectsChildren attribute: Get linked objectsIReadOnlyCollection LinkedObjectsCountChildren attribute: Get children countint CountListChildren attribute: Get children collectionIReadOnlyCollection ListItemChildren attribute: Get child by indexSpeosDes.MultipleOpticalAxis Item### LightGuide.LightGuideBodyProfile

### Method

NameDescriptionSyntaxSetLink attribute: Set the link to a script objectbool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)SetLink attribute: Set the link to a DocObjectbool Set(SpaceClaim.Api.V242.IDocObject selectedObject)SetLink attribute: Set the link to an object (IDocObject type from unspecified version)bool Set(object docObjectFromPreviousVersion)ClearLink attribute: Clear the linkvoid Clear()### Property

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed objectSpaceClaim.Api.V242.IDocObject LinkedObject### LightGuide.LightGuideOpticalAxis

### Method

NameDescriptionSyntaxSetLink attribute: Set the link to a script objectbool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)SetLink attribute: Set the link to a DocObjectbool Set(SpaceClaim.Api.V242.IDocObject selectedObject)SetLink attribute: Set the link to an object (IDocObject type from unspecified version)bool Set(object docObjectFromPreviousVersion)ClearLink attribute: Clear the linkvoid Clear()### Property

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed objectSpaceClaim.Api.V242.IDocObject LinkedObject### LightGuide.LightGuideOrientationSurface

### Method

NameDescriptionSyntaxSetLink attribute: Set the link to a script objectbool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)SetLink attribute: Set the link to a DocObjectbool Set(SpaceClaim.Api.V242.IDocObject selectedObject)SetLink attribute: Set the link to an object (IDocObject type from unspecified version)bool Set(object docObjectFromPreviousVersion)ClearLink attribute: Clear the linkvoid Clear()### Property

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed objectSpaceClaim.Api.V242.IDocObject LinkedObject### LightGuide.LightGuideProjectionAxis

### Method

NameDescriptionSyntaxSetLink attribute: Set the link to a script objectbool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)SetLink attribute: Set the link to a DocObjectbool Set(SpaceClaim.Api.V242.IDocObject selectedObject)SetLink attribute: Set the link to an object (IDocObject type from unspecified version)bool Set(object docObjectFromPreviousVersion)ClearLink attribute: Clear the linkvoid Clear()### Property

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed objectSpaceClaim.Api.V242.IDocObject LinkedObject### LightGuide.LightGuideStepConfigurations

### Method

NameDescriptionSyntaxSetChildren attribute: Set from an array of script objectsbool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject\[\] selectedObjects)SetChildren attribute: Set from an array of document objectsbool Set(SpaceClaim.Api.V242.IDocObject\[\] selectedObjects)SetChildren attribute: Set from an array of objects (IDocObject type from unspecified version)bool Set(System.Object\[\] docObjectsFromPreviousVersion)GetEnumeratorChildren attribute: Get children enumerationIEnumerator&lt;SpeosDes.ControlPointConfiguration&gt; GetEnumerator()AddNewChildren attribute: Create a new child objectSpeosDes.ControlPointConfiguration AddNew(int insertIndex)DeleteChildren attribute: Delete a child object by indexbool Delete(int index)ClearChildren attribute: Empty the listvoid Clear()SelectAllChildren attribute: Create children for all objects that are compatible with link selection.void SelectAll()### Property

NameDescriptionSyntaxLinkedObjectsChildren attribute: Get linked objectsIReadOnlyCollection&lt;SpaceClaim.Api.V242.IDocObject&gt; LinkedObjectsCountChildren attribute: Get children countint CountListChildren attribute: Get children collectionIReadOnlyCollection&lt;SpeosDes.ControlPointConfiguration&gt; ListItemChildren attribute: Get child by indexSpeosDes.ControlPointConfiguration Item### LightGuide.LightGuideLengthConfigurations

### Method

NameDescriptionSyntaxSetChildren attribute: Set from an array of script objectsbool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject\[\] selectedObjects)SetChildren attribute: Set from an array of document objectsbool Set(SpaceClaim.Api.V242.IDocObject\[\] selectedObjects)SetChildren attribute: Set from an array of objects (IDocObject type from unspecified version)bool Set(System.Object\[\] docObjectsFromPreviousVersion)GetEnumeratorChildren attribute: Get children enumerationIEnumerator&lt;SpeosDes.ControlPointConfiguration&gt; GetEnumerator()AddNewChildren attribute: Create a new child objectSpeosDes.ControlPointConfiguration AddNew(int insertIndex)DeleteChildren attribute: Delete a child object by indexbool Delete(int index)ClearChildren attribute: Empty the listvoid Clear()SelectAllChildren attribute: Create children for all objects that are compatible with link selection.void SelectAll()### Property

NameDescriptionSyntaxLinkedObjectsChildren attribute: Get linked objectsIReadOnlyCollection&lt;SpaceClaim.Api.V242.IDocObject&gt; LinkedObjectsCountChildren attribute: Get children countint CountListChildren attribute: Get children collectionIReadOnlyCollection&lt;SpeosDes.ControlPointConfiguration&gt; ListItemChildren attribute: Get child by indexSpeosDes.ControlPointConfiguration Item### LightGuide.LightGuideTrimmingRatioConfigurations

### Method

NameDescriptionSyntaxSetChildren attribute: Set from an array of script objectsbool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject\[\] selectedObjects)SetChildren attribute: Set from an array of document objectsbool Set(SpaceClaim.Api.V242.IDocObject\[\] selectedObjects)SetChildren attribute: Set from an array of objects (IDocObject type from unspecified version)bool Set(System.Object\[\] docObjectsFromPreviousVersion)GetEnumeratorChildren attribute: Get children enumerationIEnumerator&lt;SpeosDes.ControlPointConfiguration&gt; GetEnumerator()AddNewChildren attribute: Create a new child objectSpeosDes.ControlPointConfiguration AddNew(int insertIndex)DeleteChildren attribute: Delete a child object by indexbool Delete(int index)ClearChildren attribute: Empty the listvoid Clear()SelectAllChildren attribute: Create children for all objects that are compatible with link selection.void SelectAll()### Property

NameDescriptionSyntaxLinkedObjectsChildren attribute: Get linked objectsIReadOnlyCollection&lt;SpaceClaim.Api.V242.IDocObject&gt; LinkedObjectsCountChildren attribute: Get children countint CountListChildren attribute: Get children collectionIReadOnlyCollection&lt;SpeosDes.ControlPointConfiguration&gt; ListItemChildren attribute: Get child by indexSpeosDes.ControlPointConfiguration Item### LightGuide.LightGuidePeakTrimmingRatioConfigurations

### Method

NameDescriptionSyntaxSetChildren attribute: Set from an array of script objectsbool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject\[\] selectedObjects)SetChildren attribute: Set from an array of document objectsbool Set(SpaceClaim.Api.V242.IDocObject\[\] selectedObjects)SetChildren attribute: Set from an array of objects (IDocObject type from unspecified version)bool Set(System.Object\[\] docObjectsFromPreviousVersion)GetEnumeratorChildren attribute: Get children enumerationIEnumerator&lt;SpeosDes.ControlPointConfiguration&gt; GetEnumerator()AddNewChildren attribute: Create a new child objectSpeosDes.ControlPointConfiguration AddNew(int insertIndex)DeleteChildren attribute: Delete a child object by indexbool Delete(int index)ClearChildren attribute: Empty the listvoid Clear()SelectAllChildren attribute: Create children for all objects that are compatible with link selection.void SelectAll()### Property

NameDescriptionSyntaxLinkedObjectsChildren attribute: Get linked objectsIReadOnlyCollection&lt;SpaceClaim.Api.V242.IDocObject&gt; LinkedObjectsCountChildren attribute: Get children countint CountListChildren attribute: Get children collectionIReadOnlyCollection&lt;SpeosDes.ControlPointConfiguration&gt; ListItemChildren attribute: Get child by indexSpeosDes.ControlPointConfiguration Item### LightGuide.LightGuideOffsetConfigurations

### Method

NameDescriptionSyntaxSetChildren attribute: Set from an array of script objectsbool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject\[\] selectedObjects)SetChildren attribute: Set from an array of document objectsbool Set(SpaceClaim.Api.V242.IDocObject\[\] selectedObjects)SetChildren attribute: Set from an array of objects (IDocObject type from unspecified version)bool Set(System.Object\[\] docObjectsFromPreviousVersion)GetEnumeratorChildren attribute: Get children enumerationIEnumerator&lt;SpeosDes.ControlPointConfiguration&gt; GetEnumerator()AddNewChildren attribute: Create a new child objectSpeosDes.ControlPointConfiguration AddNew(int insertIndex)DeleteChildren attribute: Delete a child object by indexbool Delete(int index)ClearChildren attribute: Empty the listvoid Clear()SelectAllChildren attribute: Create children for all objects that are compatible with link selection.void SelectAll()### Property

NameDescriptionSyntaxLinkedObjectsChildren attribute: Get linked objectsIReadOnlyCollection&lt;SpaceClaim.Api.V242.IDocObject&gt; LinkedObjectsCountChildren attribute: Get children countint CountListChildren attribute: Get children collectionIReadOnlyCollection&lt;SpeosDes.ControlPointConfiguration&gt; ListItemChildren attribute: Get child by indexSpeosDes.ControlPointConfiguration Item### LightGuide.LightGuideWidthConfigurations

### Method

NameDescriptionSyntaxSetChildren attribute: Set from an array of script objectsbool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject\[\] selectedObjects)SetChildren attribute: Set from an array of document objectsbool Set(SpaceClaim.Api.V242.IDocObject\[\] selectedObjects)SetChildren attribute: Set from an array of objects (IDocObject type from unspecified version)bool Set(System.Object\[\] docObjectsFromPreviousVersion)GetEnumeratorChildren attribute: Get children enumerationIEnumerator&lt;SpeosDes.ControlPointConfiguration&gt; GetEnumerator()AddNewChildren attribute: Create a new child objectSpeosDes.ControlPointConfiguration AddNew(int insertIndex)DeleteChildren attribute: Delete a child object by indexbool Delete(int index)ClearChildren attribute: Empty the listvoid Clear()SelectAllChildren attribute: Create children for all objects that are compatible with link selection.void SelectAll()### Property

NameDescriptionSyntaxLinkedObjectsChildren attribute: Get linked objectsIReadOnlyCollection&lt;SpaceClaim.Api.V242.IDocObject&gt; LinkedObjectsCountChildren attribute: Get children countint CountListChildren attribute: Get children collectionIReadOnlyCollection&lt;SpeosDes.ControlPointConfiguration&gt; ListItemChildren attribute: Get child by indexSpeosDes.ControlPointConfiguration Item### LightGuide.LightGuideStartAngleConfigurations

### Method

NameDescriptionSyntaxSetChildren attribute: Set from an array of script objectsbool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject\[\] selectedObjects)SetChildren attribute: Set from an array of document objectsbool Set(SpaceClaim.Api.V242.IDocObject\[\] selectedObjects)SetChildren attribute: Set from an array of objects (IDocObject type from unspecified version)bool Set(System.Object\[\] docObjectsFromPreviousVersion)GetEnumeratorChildren attribute: Get children enumerationIEnumerator&lt;SpeosDes.ControlPointConfiguration&gt; GetEnumerator()AddNewChildren attribute: Create a new child objectSpeosDes.ControlPointConfiguration AddNew(int insertIndex)DeleteChildren attribute: Delete a child object by indexbool Delete(int index)ClearChildren attribute: Empty the listvoid Clear()SelectAllChildren attribute: Create children for all objects that are compatible with link selection.void SelectAll()### Property

NameDescriptionSyntaxLinkedObjectsChildren attribute: Get linked objectsIReadOnlyCollection&lt;SpaceClaim.Api.V242.IDocObject&gt; LinkedObjectsCountChildren attribute: Get children countint CountListChildren attribute: Get children collectionIReadOnlyCollection&lt;SpeosDes.ControlPointConfiguration&gt; ListItemChildren attribute: Get child by indexSpeosDes.ControlPointConfiguration Item### LightGuide.LightGuideEndAngleConfigurations

### Method

NameDescriptionSyntaxSetChildren attribute: Set from an array of script objectsbool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject\[\] selectedObjects)SetChildren attribute: Set from an array of document objectsbool Set(SpaceClaim.Api.V242.IDocObject\[\] selectedObjects)SetChildren attribute: Set from an array of objects (IDocObject type from unspecified version)bool Set(System.Object\[\] docObjectsFromPreviousVersion)GetEnumeratorChildren attribute: Get children enumerationIEnumerator&lt;SpeosDes.ControlPointConfiguration&gt; GetEnumerator()AddNewChildren attribute: Create a new child objectSpeosDes.ControlPointConfiguration AddNew(int insertIndex)DeleteChildren attribute: Delete a child object by indexbool Delete(int index)ClearChildren attribute: Empty the listvoid Clear()SelectAllChildren attribute: Create children for all objects that are compatible with link selection.void SelectAll()### Property

NameDescriptionSyntaxLinkedObjectsChildren attribute: Get linked objectsIReadOnlyCollection&lt;SpaceClaim.Api.V242.IDocObject&gt; LinkedObjectsCountChildren attribute: Get children countint CountListChildren attribute: Get children collectionIReadOnlyCollection&lt;SpeosDes.ControlPointConfiguration&gt; ListItemChildren attribute: Get child by indexSpeosDes.ControlPointConfiguration Item### LightGuide.LightGuideStartRadiusConfigurations

### Method

NameDescriptionSyntaxSetChildren attribute: Set from an array of script objectsbool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject\[\] selectedObjects)SetChildren attribute: Set from an array of document objectsbool Set(SpaceClaim.Api.V242.IDocObject\[\] selectedObjects)SetChildren attribute: Set from an array of objects (IDocObject type from unspecified version)bool Set(System.Object\[\] docObjectsFromPreviousVersion)GetEnumeratorChildren attribute: Get children enumerationIEnumerator&lt;SpeosDes.ControlPointConfiguration&gt; GetEnumerator()AddNewChildren attribute: Create a new child objectSpeosDes.ControlPointConfiguration AddNew(int insertIndex)DeleteChildren attribute: Delete a child object by indexbool Delete(int index)ClearChildren attribute: Empty the listvoid Clear()SelectAllChildren attribute: Create children for all objects that are compatible with link selection.void SelectAll()### Property

NameDescriptionSyntaxLinkedObjectsChildren attribute: Get linked objectsIReadOnlyCollection&lt;SpaceClaim.Api.V242.IDocObject&gt; LinkedObjectsCountChildren attribute: Get children countint CountListChildren attribute: Get children collectionIReadOnlyCollection&lt;SpeosDes.ControlPointConfiguration&gt; ListItemChildren attribute: Get child by indexSpeosDes.ControlPointConfiguration Item### LightGuide.LightGuideEndRadiusConfigurations

### Method

NameDescriptionSyntaxSetChildren attribute: Set from an array of script objectsbool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject\[\] selectedObjects)SetChildren attribute: Set from an array of document objectsbool Set(SpaceClaim.Api.V242.IDocObject\[\] selectedObjects)SetChildren attribute: Set from an array of objects (IDocObject type from unspecified version)bool Set(System.Object\[\] docObjectsFromPreviousVersion)GetEnumeratorChildren attribute: Get children enumerationIEnumerator&lt;SpeosDes.ControlPointConfiguration&gt; GetEnumerator()AddNewChildren attribute: Create a new child objectSpeosDes.ControlPointConfiguration AddNew(int insertIndex)DeleteChildren attribute: Delete a child object by indexbool Delete(int index)ClearChildren attribute: Empty the listvoid Clear()SelectAllChildren attribute: Create children for all objects that are compatible with link selection.void SelectAll()### Property

NameDescriptionSyntaxLinkedObjectsChildren attribute: Get linked objectsIReadOnlyCollection&lt;SpaceClaim.Api.V242.IDocObject&gt; LinkedObjectsCountChildren attribute: Get children countint CountListChildren attribute: Get children collectionIReadOnlyCollection&lt;SpeosDes.ControlPointConfiguration&gt; ListItemChildren attribute: Get child by indexSpeosDes.ControlPointConfiguration Item### LightGuide.LightGuideMillingConfigurations

### Method

NameDescriptionSyntaxSetChildren attribute: Set from an array of script objectsbool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject\[\] selectedObjects)SetChildren attribute: Set from an array of document objectsbool Set(SpaceClaim.Api.V242.IDocObject\[\] selectedObjects)SetChildren attribute: Set from an array of objects (IDocObject type from unspecified version)bool Set(System.Object\[\] docObjectsFromPreviousVersion)GetEnumeratorChildren attribute: Get children enumerationIEnumerator&lt;SpeosDes.ControlPointConfiguration&gt; GetEnumerator()AddNewChildren attribute: Create a new child objectSpeosDes.ControlPointConfiguration AddNew(int insertIndex)DeleteChildren attribute: Delete a child object by indexbool Delete(int index)ClearChildren attribute: Empty the listvoid Clear()SelectAllChildren attribute: Create children for all objects that are compatible with link selection.void SelectAll()### Property

NameDescriptionSyntaxLinkedObjectsChildren attribute: Get linked objectsIReadOnlyCollection&lt;SpaceClaim.Api.V242.IDocObject&gt; LinkedObjectsCountChildren attribute: Get children countint CountListChildren attribute: Get children collectionIReadOnlyCollection&lt;SpeosDes.ControlPointConfiguration&gt; ListItemChildren attribute: Get child by indexSpeosDes.ControlPointConfiguration Item### LightGuide.LightGuideBottomPrismMillingConfigurations

### Method

NameDescriptionSyntaxSetChildren attribute: Set from an array of script objectsbool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject\[\] selectedObjects)SetChildren attribute: Set from an array of document objectsbool Set(SpaceClaim.Api.V242.IDocObject\[\] selectedObjects)SetChildren attribute: Set from an array of objects (IDocObject type from unspecified version)bool Set(System.Object\[\] docObjectsFromPreviousVersion)GetEnumeratorChildren attribute: Get children enumerationIEnumerator&lt;SpeosDes.ControlPointConfiguration&gt; GetEnumerator()AddNewChildren attribute: Create a new child objectSpeosDes.ControlPointConfiguration AddNew(int insertIndex)DeleteChildren attribute: Delete a child object by indexbool Delete(int index)ClearChildren attribute: Empty the listvoid Clear()SelectAllChildren attribute: Create children for all objects that are compatible with link selection.void SelectAll()### Property

NameDescriptionSyntaxLinkedObjectsChildren attribute: Get linked objectsIReadOnlyCollection&lt;SpaceClaim.Api.V242.IDocObject&gt; LinkedObjectsCountChildren attribute: Get children countint CountListChildren attribute: Get children collectionIReadOnlyCollection&lt;SpeosDes.ControlPointConfiguration&gt; ListItemChildren attribute: Get child by indexSpeosDes.ControlPointConfiguration Item### LightGuide.LightGuideDemoldingOrientation

### Method

NameDescriptionSyntaxSetLink attribute: Set the link to a script objectbool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)SetLink attribute: Set the link to a DocObjectbool Set(SpaceClaim.Api.V242.IDocObject selectedObject)SetLink attribute: Set the link to an object (IDocObject type from unspecified version)bool Set(object docObjectFromPreviousVersion)ClearLink attribute: Clear the linkvoid Clear()### Property

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed objectSpaceClaim.Api.V242.IDocObject LinkedObject## MOS

### Static method

NameDescriptionSyntaxFromSelectionConvert Items of a ScriptSelection to a list of Speos objects when their type is matching.IEnumerable&lt;SpeosDes.MOS&gt; FromSelection(IEnumerable&lt;SpaceClaim.Api.V242.IDocObject&gt; selectionItems)FindReturns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.\*")SpeosDes.MOS Find(string objectName)CreateCreate a new object of this type under the specified parent componentSpeosDes.MOS Create(object parent)CreateCreate a new object in the active contextSpeosDes.MOS Create()### Method

NameDescriptionSyntaxCloneCreate a copy of this object in the active contextSpeosDes.MOS Clone()CopyToCreate a copy of this object and paste it to the specified destinationSpeosDes.MOS CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)ExportAsCSVFilevoid ExportAsCSVFile(string csvFilePath)ExtractToolingPathvoid ExtractToolingPath()FindOccurrenceInActivePartSearch for occurrences of this object in the active Partobject FindOccurrenceInActivePart()FindOccurrenceInContextOfSearch for occurrences of this object in the specified PartSpaceClaim.Api.V242.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V242.IDocObject contextObject)ToStringGet a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable)string ToString()DeleteDelete this objectbool Delete()GetChildSubjectsRetrieve all children as DocObjectsIEnumerable&lt;SpaceClaim.Api.V242.CustomObject&gt; GetChildSubjects()GetChildrenRetrieve all direct children of a given typeIEnumerable&lt;TSpecificApiType&gt; GetChildren&lt;TSpecificApiType&gt;()ComputeExecute the Compute command on the objectvoid Compute()PublishParameterPublish or un-publish a number attribute as driving parametervoid PublishParameter(string fieldName, bool trueToPublish)PublishAllParametersToWorkbenchCall this method to expose all object's attributes so that they can be accessible and driven from Workbench.void PublishAllParametersToWorkbench(bool trueToPublish)ApplyPresetUpdate the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error.void ApplyPreset(string presetFilePath)ExportToPresetExport the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error.string ExportToPreset(string filePath)### Property

NameDescriptionSyntaxGuideCurveLinks attributeSpeosDes.MOS.MOSGuideCurve GuideCurveReverseGuideCurveDirectionBoolean attributebool ReverseGuideCurveDirectionSecondCurveLinks attributeSpeosDes.MOS.MOSSecondCurve SecondCurveConstructionTypeEnum attributeSpeosDes.MOS.EnumConstructionType ConstructionTypeConstructionTypeIndexEnum attribute (as index)int ConstructionTypeIndexOpticalAxisLink attributeSpeosDes.MOS.MOSOpticalAxis OpticalAxisReverseOpticalAxisDirectionBoolean attributebool ReverseOpticalAxisDirectionSupportSurfaceLink attributeSpeosDes.MOS.MOSSupportSurface SupportSurfaceProjectionTypeEnum attributeSpeosDes.MOS.EnumProjectionType ProjectionTypeProjectionTypeIndexEnum attribute (as index)int ProjectionTypeIndexSupportSideEnum attributeSpeosDes.MOS.EnumSupportSide SupportSideSupportSideIndexEnum attribute (as index)int SupportSideIndexThicknessNumber attributedouble ThicknessThicknessTextNumber attribute (as text)string ThicknessTextSideAngleNumber attributedouble SideAngleSideAngleTextNumber attribute (as text)string SideAngleTextRadiusNumber attributedouble RadiusRadiusTextNumber attribute (as text)string RadiusTextControlPointsChildren attributeSpeosDes.MOS.MOSControlPoints ControlPointsStripesCountNumber attributeint StripesCountStripesCountTextNumber attribute (as text)string StripesCountTextDraftingAxisLink attributeSpeosDes.MOS.MOSDraftingAxis DraftingAxisReverseDraftingAxisDirectionBoolean attributebool ReverseDraftingAxisDirectionDraftingAngleNumber attributedouble DraftingAngleDraftingAngleTextNumber attribute (as text)string DraftingAngleTextSubjectDeprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapperSpaceClaim.Api.V242.CustomObject SubjectOccurrenceGet the underlying CustomObject occurrence, associated to the API object wrapper in current API versionobject OccurrenceNameGet or Set the name of the objectstring NameVisibleChange the visibility status (same behavior as checking/unchecking on the tree view item)bool VisibleStatusInfoGet the status of the object (warning or error message)string StatusInfoIsUpToDateAsk if the object was modified since its last successful computationbool IsUpToDate### MOS.MOSGuideCurve

### Method

NameDescriptionSyntaxSetLinks attribute: Link to an array of script objectsbool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject\[\] selectedObjects)SetLinks attribute: Link to an array of document objectsbool Set(SpaceClaim.Api.V242.IDocObject\[\] selectedObjects)SetLinks attribute: Link to an array of document objects (IDocObject type from unspecified version)bool Set(System.Object\[\] docObjectsFromPreviousVersion)ClearLinks attribute: Clear the list of linksvoid Clear()SelectAllLinks attribute: Link to all compatible objects in the active contextvoid SelectAll()### Property

NameDescriptionSyntaxLinkedObjectsLinks attribute: Get the pointed document objectsIReadOnlyCollection&lt;SpaceClaim.Api.V242.IDocObject&gt; LinkedObjectsItemLinks attribute: Get a pointed document object by indexSpaceClaim.Api.V242.IDocObject ItemCountLinks attribute: Get the links countint Count### MOS.MOSSecondCurve

### Method

NameDescriptionSyntaxSetLinks attribute: Link to an array of script objectsbool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject\[\] selectedObjects)SetLinks attribute: Link to an array of document objectsbool Set(SpaceClaim.Api.V242.IDocObject\[\] selectedObjects)SetLinks attribute: Link to an array of document objects (IDocObject type from unspecified version)bool Set(System.Object\[\] docObjectsFromPreviousVersion)ClearLinks attribute: Clear the list of linksvoid Clear()SelectAllLinks attribute: Link to all compatible objects in the active contextvoid SelectAll()### Property

NameDescriptionSyntaxLinkedObjectsLinks attribute: Get the pointed document objectsIReadOnlyCollection&lt;SpaceClaim.Api.V242.IDocObject&gt; LinkedObjectsItemLinks attribute: Get a pointed document object by indexSpaceClaim.Api.V242.IDocObject ItemCountLinks attribute: Get the links countint Count### MOS.MOSOpticalAxis

### Method

NameDescriptionSyntaxSetLink attribute: Set the link to a script objectbool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)SetLink attribute: Set the link to a DocObjectbool Set(SpaceClaim.Api.V242.IDocObject selectedObject)SetLink attribute: Set the link to an object (IDocObject type from unspecified version)bool Set(object docObjectFromPreviousVersion)ClearLink attribute: Clear the linkvoid Clear()### Property

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed objectSpaceClaim.Api.V242.IDocObject LinkedObject### MOS.MOSSupportSurface

### Method

NameDescriptionSyntaxSetLink attribute: Set the link to a script objectbool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)SetLink attribute: Set the link to a DocObjectbool Set(SpaceClaim.Api.V242.IDocObject selectedObject)SetLink attribute: Set the link to an object (IDocObject type from unspecified version)bool Set(object docObjectFromPreviousVersion)ClearLink attribute: Clear the linkvoid Clear()### Property

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed objectSpaceClaim.Api.V242.IDocObject LinkedObject### MOS.MOSControlPoints

### Method

NameDescriptionSyntaxSetChildren attribute: Set from an array of script objectsbool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject\[\] selectedObjects)SetChildren attribute: Set from an array of document objectsbool Set(SpaceClaim.Api.V242.IDocObject\[\] selectedObjects)SetChildren attribute: Set from an array of objects (IDocObject type from unspecified version)bool Set(System.Object\[\] docObjectsFromPreviousVersion)GetEnumeratorChildren attribute: Get children enumerationIEnumerator&lt;SpeosDes.MOSControlPoint&gt; GetEnumerator()AddNewChildren attribute: Create a new child objectSpeosDes.MOSControlPoint AddNew(int insertIndex)DeleteChildren attribute: Delete a child object by indexbool Delete(int index)ClearChildren attribute: Empty the listvoid Clear()SelectAllChildren attribute: Create children for all objects that are compatible with link selection.void SelectAll()### Property

NameDescriptionSyntaxLinkedObjectsChildren attribute: Get linked objectsIReadOnlyCollection&lt;SpaceClaim.Api.V242.IDocObject&gt; LinkedObjectsCountChildren attribute: Get children countint CountListChildren attribute: Get children collectionIReadOnlyCollection&lt;SpeosDes.MOSControlPoint&gt; ListItemChildren attribute: Get child by indexSpeosDes.MOSControlPoint Item### MOS.MOSDraftingAxis

### Method

NameDescriptionSyntaxSetLink attribute: Set the link to a script objectbool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)SetLink attribute: Set the link to a DocObjectbool Set(SpaceClaim.Api.V242.IDocObject selectedObject)SetLink attribute: Set the link to an object (IDocObject type from unspecified version)bool Set(object docObjectFromPreviousVersion)ClearLink attribute: Clear the linkvoid Clear()### Property

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed objectSpaceClaim.Api.V242.IDocObject LinkedObject## MOSControlPoint

### Static method

NameDescriptionSyntaxCreateCreate a new object of this typeSpeosDes.MOSControlPoint Create()### Method

NameDescriptionSyntaxToStringstring ToString()### Property

NameDescriptionSyntaxPositionNumber attributedouble PositionPositionTextNumber attribute (as text)string PositionTextDepthNumber attributedouble DepthDepthTextNumber attribute (as text)string DepthTextPitchNumber attributedouble PitchPitchTextNumber attribute (as text)string PitchTextTopLengthNumber attributedouble TopLengthTopLengthTextNumber attribute (as text)string TopLengthTextBitShapeStartAngleNumber attributedouble BitShapeStartAngleBitShapeStartAngleTextNumber attribute (as text)string BitShapeStartAngleTextBitShapeEndAngleNumber attributedouble BitShapeEndAngleBitShapeEndAngleTextNumber attribute (as text)string BitShapeEndAngleText## MultipleOpticalAxis

### Static method

NameDescriptionSyntaxCreateCreate a new object of this typeSpeosDes.MultipleOpticalAxis Create()### Method

NameDescriptionSyntaxToStringstring ToString()### Property

NameDescriptionSyntaxPositionNumber attributedouble PositionPositionTextNumber attribute (as text)string PositionTextOpticalAxisLink attributeSpeosDes.MultipleOpticalAxis.MultipleOpticalAxisOpticalAxis OpticalAxisReverseDirectionBoolean attributebool ReverseDirection### MultipleOpticalAxis.MultipleOpticalAxisOpticalAxis

### Method

NameDescriptionSyntaxSetLink attribute: Set the link to a DocObjectbool Set(SpaceClaim.Api.V242.IDocObject selectedObject)SetLink attribute: Set the link to an object (IDocObject type from unspecified version)bool Set(object docObjectFromPreviousVersion)ClearLink attribute: Clear the linkvoid Clear()### Property

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed objectSpaceClaim.Api.V242.IDocObject LinkedObject## Node

### Static method

NameDescriptionSyntaxFromSelectionConvert Items of a ScriptSelection to a list of Speos objects when their type is matching.IEnumerable&lt;SpeosDes.Node&gt; FromSelection(IEnumerable&lt;SpaceClaim.Api.V242.IDocObject&gt; selectionItems)FindReturns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.\*")SpeosDes.Node Find(string objectName)CreateCreate a new object of this type under the specified parent componentSpeosDes.Node Create(object parent)CreateCreate a new object in the active contextSpeosDes.Node Create()### Method

NameDescriptionSyntaxCloneCreate a copy of this object in the active contextSpeosDes.Node Clone()CopyToCreate a copy of this object and paste it to the specified destinationSpeosDes.Node CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)FindOccurrenceInActivePartSearch for occurrences of this object in the active Partobject FindOccurrenceInActivePart()FindOccurrenceInContextOfSearch for occurrences of this object in the specified PartSpaceClaim.Api.V242.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V242.IDocObject contextObject)ToStringGet a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable)string ToString()DeleteDelete this objectbool Delete()GetChildSubjectsRetrieve all children as DocObjectsIEnumerable&lt;SpaceClaim.Api.V242.CustomObject&gt; GetChildSubjects()GetChildrenRetrieve all direct children of a given typeIEnumerable&lt;TSpecificApiType&gt; GetChildren&lt;TSpecificApiType&gt;()ComputeExecute the Compute command on the objectvoid Compute()PublishParameterPublish or un-publish a number attribute as driving parametervoid PublishParameter(string fieldName, bool trueToPublish)PublishAllParametersToWorkbenchCall this method to expose all object's attributes so that they can be accessible and driven from Workbench.void PublishAllParametersToWorkbench(bool trueToPublish)ApplyPresetUpdate the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error.void ApplyPreset(string presetFilePath)ExportToPresetExport the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error.string ExportToPreset(string filePath)### Property

NameDescriptionSyntaxSubjectDeprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapperSpaceClaim.Api.V242.CustomObject SubjectOccurrenceGet the underlying CustomObject occurrence, associated to the API object wrapper in current API versionobject OccurrenceNameGet or Set the name of the objectstring NameVisibleChange the visibility status (same behavior as checking/unchecking on the tree view item)bool VisibleStatusInfoGet the status of the object (warning or error message)string StatusInfoIsUpToDateAsk if the object was modified since its last successful computationbool IsUpToDate## OpticalFeatureGeneral

### Static method

NameDescriptionSyntaxFromSelectionConvert Items of a ScriptSelection to a list of Speos objects when their type is matching.IEnumerable&lt;SpeosDes.OpticalFeatureGeneral&gt; FromSelection(IEnumerable&lt;SpaceClaim.Api.V242.IDocObject&gt; selectionItems)FindReturns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.\*")SpeosDes.OpticalFeatureGeneral Find(string objectName)### Method

NameDescriptionSyntaxGetSourceTypePossibleValuesString list attribute: List possible valuesIEnumerable GetSourceTypePossibleValues()FindOccurrenceInActivePartSearch for occurrences of this object in the active Partobject FindOccurrenceInActivePart()FindOccurrenceInContextOfSearch for occurrences of this object in the specified PartSpaceClaim.Api.V242.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V242.IDocObject contextObject)ToStringGet a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable)string ToString()DeleteDelete this objectbool Delete()GetChildSubjectsRetrieve all children as DocObjectsIEnumerable&lt;SpaceClaim.Api.V242.CustomObject&gt; GetChildSubjects()GetChildrenRetrieve all direct children of a given typeIEnumerable&lt;TSpecificApiType&gt; GetChildren&lt;TSpecificApiType&gt;()ComputeExecute the Compute command on the objectvoid Compute()PublishParameterPublish or un-publish a number attribute as driving parametervoid PublishParameter(string fieldName, bool trueToPublish)PublishAllParametersToWorkbenchCall this method to expose all object's attributes so that they can be accessible and driven from Workbench.void PublishAllParametersToWorkbench(bool trueToPublish)ApplyPresetUpdate the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error.void ApplyPreset(string presetFilePath)ExportToPresetExport the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error.string ExportToPreset(string filePath)### Property

NameDescriptionSyntaxSourceTypeString list selection attributestring SourceTypeSourcePointLink attributeSpeosDes.OpticalFeatureGeneral.OpticalFeatureGeneralSourcePoint SourcePointSourceBodyLink attributeSpeosDes.OpticalFeatureGeneral.OpticalFeatureGeneralSourceBody SourceBodySourceDirectionLink attributeSpeosDes.OpticalFeatureGeneral.OpticalFeatureGeneralSourceDirection SourceDirectionReverseSourceDirectionBoolean attributebool ReverseSourceDirectionSourceRefractiveIndexNumber attributedouble SourceRefractiveIndexSourceRefractiveIndexTextNumber attribute (as text)string SourceRefractiveIndexTextSourceFluxNumber attributedouble SourceFluxSourceFluxTextNumber attribute (as text)string SourceFluxTextSupportTypeEnum attributeSpeosDes.OpticalFeatureGeneral.EnumSupportType SupportTypeSupportTypeIndexEnum attribute (as index)int SupportTypeIndexSupportBodyLink attributeSpeosDes.OpticalFeatureGeneral.OpticalFeatureGeneralSupportBody SupportBodySupportOriginLink attributeSpeosDes.OpticalFeatureGeneral.OpticalFeatureGeneralSupportOrigin SupportOriginSupportAxisLink attributeSpeosDes.OpticalFeatureGeneral.OpticalFeatureGeneralSupportAxis SupportAxisReverseSupportAxisBoolean attributebool ReverseSupportAxisSupportOrientationLink attributeSpeosDes.OpticalFeatureGeneral.OpticalFeatureGeneralSupportOrientation SupportOrientationReverseSupportOrientationBoolean attributebool ReverseSupportOrientationSupportOrientationTypeEnum attributeSpeosDes.OpticalFeatureGeneral.EnumSupportOrientationType SupportOrientationTypeSupportOrientationTypeIndexEnum attribute (as index)int SupportOrientationTypeIndexThicknessNumber attributedouble ThicknessThicknessTextNumber attribute (as text)string ThicknessTextRefractiveIndexNumber attributedouble RefractiveIndexRefractiveIndexTextNumber attribute (as text)string RefractiveIndexTextTargetTypeEnum attributeSpeosDes.OpticalFeatureGeneral.EnumTargetType TargetTypeTargetTypeIndexEnum attribute (as index)int TargetTypeIndexIntegrationDirectionIsReversedBoolean attributebool IntegrationDirectionIsReversedXMPTemplateFileFile attributestring XMPTemplateFileXMPTemplateFileFullPathFile attribute (absolute full path)string XMPTemplateFileFullPathTargetOriginLink attributeSpeosDes.OpticalFeatureGeneral.OpticalFeatureGeneralTargetOrigin TargetOriginTargetAxisLink attributeSpeosDes.OpticalFeatureGeneral.OpticalFeatureGeneralTargetAxis TargetAxisReverseTargetAxisBoolean attributebool ReverseTargetAxisTargetOrientationLink attributeSpeosDes.OpticalFeatureGeneral.OpticalFeatureGeneralTargetOrientation TargetOrientationReverseTargetOrientationBoolean attributebool ReverseTargetOrientationResultViewingDirectionEnum attributeSpeosDes.OpticalFeatureGeneral.EnumResultViewingDirection ResultViewingDirectionResultViewingDirectionIndexEnum attribute (as index)int ResultViewingDirectionIndexSubjectDeprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapperSpaceClaim.Api.V242.CustomObject SubjectOccurrenceGet the underlying CustomObject occurrence, associated to the API object wrapper in current API versionobject OccurrenceNameGet or Set the name of the objectstring NameVisibleChange the visibility status (same behavior as checking/unchecking on the tree view item)bool VisibleStatusInfoGet the status of the object (warning or error message)string StatusInfoIsUpToDateAsk if the object was modified since its last successful computationbool IsUpToDate### OpticalFeatureGeneral.OpticalFeatureGeneralSourcePoint

### Method

NameDescriptionSyntaxSetLink attribute: Set the link to a script objectbool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)SetLink attribute: Set the link to a DocObjectbool Set(SpaceClaim.Api.V242.IDocObject selectedObject)SetLink attribute: Set the link to an object (IDocObject type from unspecified version)bool Set(object docObjectFromPreviousVersion)ClearLink attribute: Clear the linkvoid Clear()### Property

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed objectSpaceClaim.Api.V242.IDocObject LinkedObject### OpticalFeatureGeneral.OpticalFeatureGeneralSourceBody

### Method

NameDescriptionSyntaxSetLink attribute: Set the link to a script objectbool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)SetLink attribute: Set the link to a DocObjectbool Set(SpaceClaim.Api.V242.IDocObject selectedObject)SetLink attribute: Set the link to an object (IDocObject type from unspecified version)bool Set(object docObjectFromPreviousVersion)ClearLink attribute: Clear the linkvoid Clear()### Property

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed objectSpaceClaim.Api.V242.IDocObject LinkedObject### OpticalFeatureGeneral.OpticalFeatureGeneralSourceDirection

### Method

NameDescriptionSyntaxSetLink attribute: Set the link to a script objectbool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)SetLink attribute: Set the link to a DocObjectbool Set(SpaceClaim.Api.V242.IDocObject selectedObject)SetLink attribute: Set the link to an object (IDocObject type from unspecified version)bool Set(object docObjectFromPreviousVersion)ClearLink attribute: Clear the linkvoid Clear()### Property

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed objectSpaceClaim.Api.V242.IDocObject LinkedObject### OpticalFeatureGeneral.OpticalFeatureGeneralSupportBody

### Method

NameDescriptionSyntaxSetLink attribute: Set the link to a script objectbool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)SetLink attribute: Set the link to a DocObjectbool Set(SpaceClaim.Api.V242.IDocObject selectedObject)SetLink attribute: Set the link to an object (IDocObject type from unspecified version)bool Set(object docObjectFromPreviousVersion)ClearLink attribute: Clear the linkvoid Clear()### Property

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed objectSpaceClaim.Api.V242.IDocObject LinkedObject### OpticalFeatureGeneral.OpticalFeatureGeneralSupportOrigin

### Method

NameDescriptionSyntaxSetLink attribute: Set the link to a script objectbool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)SetLink attribute: Set the link to a DocObjectbool Set(SpaceClaim.Api.V242.IDocObject selectedObject)SetLink attribute: Set the link to an object (IDocObject type from unspecified version)bool Set(object docObjectFromPreviousVersion)ClearLink attribute: Clear the linkvoid Clear()### Property

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed objectSpaceClaim.Api.V242.IDocObject LinkedObject### OpticalFeatureGeneral.OpticalFeatureGeneralSupportAxis

### Method

NameDescriptionSyntaxSetLink attribute: Set the link to a script objectbool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)SetLink attribute: Set the link to a DocObjectbool Set(SpaceClaim.Api.V242.IDocObject selectedObject)SetLink attribute: Set the link to an object (IDocObject type from unspecified version)bool Set(object docObjectFromPreviousVersion)ClearLink attribute: Clear the linkvoid Clear()### Property

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed objectSpaceClaim.Api.V242.IDocObject LinkedObject### OpticalFeatureGeneral.OpticalFeatureGeneralSupportOrientation

### Method

NameDescriptionSyntaxSetLink attribute: Set the link to a script objectbool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)SetLink attribute: Set the link to a DocObjectbool Set(SpaceClaim.Api.V242.IDocObject selectedObject)SetLink attribute: Set the link to an object (IDocObject type from unspecified version)bool Set(object docObjectFromPreviousVersion)ClearLink attribute: Clear the linkvoid Clear()### Property

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed objectSpaceClaim.Api.V242.IDocObject LinkedObject### OpticalFeatureGeneral.OpticalFeatureGeneralTargetOrigin

### Method

NameDescriptionSyntaxSetLink attribute: Set the link to a script objectbool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)SetLink attribute: Set the link to a DocObjectbool Set(SpaceClaim.Api.V242.IDocObject selectedObject)SetLink attribute: Set the link to an object (IDocObject type from unspecified version)bool Set(object docObjectFromPreviousVersion)ClearLink attribute: Clear the linkvoid Clear()### Property

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed objectSpaceClaim.Api.V242.IDocObject LinkedObject### OpticalFeatureGeneral.OpticalFeatureGeneralTargetAxis

### Method

NameDescriptionSyntaxSetLink attribute: Set the link to a script objectbool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)SetLink attribute: Set the link to a DocObjectbool Set(SpaceClaim.Api.V242.IDocObject selectedObject)SetLink attribute: Set the link to an object (IDocObject type from unspecified version)bool Set(object docObjectFromPreviousVersion)ClearLink attribute: Clear the linkvoid Clear()### Property

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed objectSpaceClaim.Api.V242.IDocObject LinkedObject### OpticalFeatureGeneral.OpticalFeatureGeneralTargetOrientation

### Method

NameDescriptionSyntaxSetLink attribute: Set the link to a script objectbool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)SetLink attribute: Set the link to a DocObjectbool Set(SpaceClaim.Api.V242.IDocObject selectedObject)SetLink attribute: Set the link to an object (IDocObject type from unspecified version)bool Set(object docObjectFromPreviousVersion)ClearLink attribute: Clear the linkvoid Clear()### Property

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed objectSpaceClaim.Api.V242.IDocObject LinkedObject## OpticalFeatureManufacturing

### Static method

NameDescriptionSyntaxFromSelectionConvert Items of a ScriptSelection to a list of Speos objects when their type is matching.IEnumerable&lt;SpeosDes.OpticalFeatureManufacturing&gt; FromSelection(IEnumerable&lt;SpaceClaim.Api.V242.IDocObject&gt; selectionItems)FindReturns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.\*")SpeosDes.OpticalFeatureManufacturing Find(string objectName)### Method

NameDescriptionSyntaxGetDraftingTypePossibleValuesString list attribute: List possible valuesIEnumerable GetDraftingTypePossibleValues()FindOccurrenceInActivePartSearch for occurrences of this object in the active Partobject FindOccurrenceInActivePart()FindOccurrenceInContextOfSearch for occurrences of this object in the specified PartSpaceClaim.Api.V242.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V242.IDocObject contextObject)ToStringGet a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable)string ToString()DeleteDelete this objectbool Delete()GetChildSubjectsRetrieve all children as DocObjectsIEnumerable&lt;SpaceClaim.Api.V242.CustomObject&gt; GetChildSubjects()GetChildrenRetrieve all direct children of a given typeIEnumerable&lt;TSpecificApiType&gt; GetChildren&lt;TSpecificApiType&gt;()ComputeExecute the Compute command on the objectvoid Compute()PublishParameterPublish or un-publish a number attribute as driving parametervoid PublishParameter(string fieldName, bool trueToPublish)PublishAllParametersToWorkbenchCall this method to expose all object's attributes so that they can be accessible and driven from Workbench.void PublishAllParametersToWorkbench(bool trueToPublish)ApplyPresetUpdate the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error.void ApplyPreset(string presetFilePath)ExportToPresetExport the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error.string ExportToPreset(string filePath)### Property

NameDescriptionSyntaxSewingBoolean attributebool SewingDraftingTypeString list selection attributestring DraftingTypeDraftValueNumber attributedouble DraftValueDraftValueTextNumber attribute (as text)string DraftValueTextDraftAllBoolean attributebool DraftAllAngularDraftValueNumber attributedouble AngularDraftValueAngularDraftValueTextNumber attribute (as text)string AngularDraftValueTextSubjectDeprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapperSpaceClaim.Api.V242.CustomObject SubjectOccurrenceGet the underlying CustomObject occurrence, associated to the API object wrapper in current API versionobject OccurrenceNameGet or Set the name of the objectstring NameVisibleChange the visibility status (same behavior as checking/unchecking on the tree view item)bool VisibleStatusInfoGet the status of the object (warning or error message)string StatusInfoIsUpToDateAsk if the object was modified since its last successful computationbool IsUpToDate## OpticalFeatureStyleCircular

### Static method

NameDescriptionSyntaxFromSelectionConvert Items of a ScriptSelection to a list of Speos objects when their type is matching.IEnumerable&lt;SpeosDes.OpticalFeatureStyleCircular&gt; FromSelection(IEnumerable&lt;SpaceClaim.Api.V242.IDocObject&gt; selectionItems)FindReturns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.\*")SpeosDes.OpticalFeatureStyleCircular Find(string objectName)### Method

NameDescriptionSyntaxFindOccurrenceInActivePartSearch for occurrences of this object in the active Partobject FindOccurrenceInActivePart()FindOccurrenceInContextOfSearch for occurrences of this object in the specified PartSpaceClaim.Api.V242.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V242.IDocObject contextObject)ToStringGet a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable)string ToString()DeleteDelete this objectbool Delete()GetChildSubjectsRetrieve all children as DocObjectsIEnumerable&lt;SpaceClaim.Api.V242.CustomObject&gt; GetChildSubjects()GetChildrenRetrieve all direct children of a given typeIEnumerable&lt;TSpecificApiType&gt; GetChildren&lt;TSpecificApiType&gt;()ComputeExecute the Compute command on the objectvoid Compute()PublishParameterPublish or un-publish a number attribute as driving parametervoid PublishParameter(string fieldName, bool trueToPublish)PublishAllParametersToWorkbenchCall this method to expose all object's attributes so that they can be accessible and driven from Workbench.void PublishAllParametersToWorkbench(bool trueToPublish)ApplyPresetUpdate the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error.void ApplyPreset(string presetFilePath)ExportToPresetExport the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error.string ExportToPreset(string filePath)### Property

NameDescriptionSyntaxStartNumber attributedouble StartStartTextNumber attribute (as text)string StartTextEndNumber attributedouble EndEndTextNumber attribute (as text)string EndTextStepNumber attributedouble StepStepTextNumber attribute (as text)string StepTextShiftTypeEnum attributeSpeosDes.OpticalFeatureStyleCircular.EnumShiftType ShiftTypeShiftTypeIndexEnum attribute (as index)int ShiftTypeIndexShiftLengthNumber attributedouble ShiftLengthShiftLengthTextNumber attribute (as text)string ShiftLengthTextShiftAngleNumber attributedouble ShiftAngleShiftAngleTextNumber attribute (as text)string ShiftAngleTextDefinitionEnum attributeSpeosDes.OpticalFeatureStyleCircular.EnumDefinition DefinitionDefinitionIndexEnum attribute (as index)int DefinitionIndexSectorsNumber attributeint SectorsSectorsTextNumber attribute (as text)string SectorsTextAngleNumber attributedouble AngleAngleTextNumber attribute (as text)string AngleTextCircularEdgesBoolean attributebool CircularEdgesStyleOriginLink attributeSpeosDes.OpticalFeatureStyleCircular.OpticalFeatureStyleCircularStyleOrigin StyleOriginStyleAxisLink attributeSpeosDes.OpticalFeatureStyleCircular.OpticalFeatureStyleCircularStyleAxis StyleAxisReverseStyleAxisBoolean attributebool ReverseStyleAxisStyleOrientationLink attributeSpeosDes.OpticalFeatureStyleCircular.OpticalFeatureStyleCircularStyleOrientation StyleOrientationReverseStyleOrientationBoolean attributebool ReverseStyleOrientationSubjectDeprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapperSpaceClaim.Api.V242.CustomObject SubjectOccurrenceGet the underlying CustomObject occurrence, associated to the API object wrapper in current API versionobject OccurrenceNameGet or Set the name of the objectstring NameVisibleChange the visibility status (same behavior as checking/unchecking on the tree view item)bool VisibleStatusInfoGet the status of the object (warning or error message)string StatusInfoIsUpToDateAsk if the object was modified since its last successful computationbool IsUpToDate### OpticalFeatureStyleCircular.OpticalFeatureStyleCircularStyleOrigin

### Method

NameDescriptionSyntaxSetLink attribute: Set the link to a script objectbool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)SetLink attribute: Set the link to a DocObjectbool Set(SpaceClaim.Api.V242.IDocObject selectedObject)SetLink attribute: Set the link to an object (IDocObject type from unspecified version)bool Set(object docObjectFromPreviousVersion)ClearLink attribute: Clear the linkvoid Clear()### Property

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed objectSpaceClaim.Api.V242.IDocObject LinkedObject### OpticalFeatureStyleCircular.OpticalFeatureStyleCircularStyleAxis

### Method

NameDescriptionSyntaxSetLink attribute: Set the link to a script objectbool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)SetLink attribute: Set the link to a DocObjectbool Set(SpaceClaim.Api.V242.IDocObject selectedObject)SetLink attribute: Set the link to an object (IDocObject type from unspecified version)bool Set(object docObjectFromPreviousVersion)ClearLink attribute: Clear the linkvoid Clear()### Property

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed objectSpaceClaim.Api.V242.IDocObject LinkedObject### OpticalFeatureStyleCircular.OpticalFeatureStyleCircularStyleOrientation

### Method

NameDescriptionSyntaxSetLink attribute: Set the link to a script objectbool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)SetLink attribute: Set the link to a DocObjectbool Set(SpaceClaim.Api.V242.IDocObject selectedObject)SetLink attribute: Set the link to an object (IDocObject type from unspecified version)bool Set(object docObjectFromPreviousVersion)ClearLink attribute: Clear the linkvoid Clear()### Property

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed objectSpaceClaim.Api.V242.IDocObject LinkedObject## OpticalFeatureStyleFreestyle

### Static method

NameDescriptionSyntaxFromSelectionConvert Items of a ScriptSelection to a list of Speos objects when their type is matching.IEnumerable&lt;SpeosDes.OpticalFeatureStyleFreestyle&gt; FromSelection(IEnumerable&lt;SpaceClaim.Api.V242.IDocObject&gt; selectionItems)FindReturns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.\*")SpeosDes.OpticalFeatureStyleFreestyle Find(string objectName)### Method

NameDescriptionSyntaxFindOccurrenceInActivePartSearch for occurrences of this object in the active Partobject FindOccurrenceInActivePart()FindOccurrenceInContextOfSearch for occurrences of this object in the specified PartSpaceClaim.Api.V242.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V242.IDocObject contextObject)ToStringGet a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable)string ToString()DeleteDelete this objectbool Delete()GetChildSubjectsRetrieve all children as DocObjectsIEnumerable&lt;SpaceClaim.Api.V242.CustomObject&gt; GetChildSubjects()GetChildrenRetrieve all direct children of a given typeIEnumerable&lt;TSpecificApiType&gt; GetChildren&lt;TSpecificApiType&gt;()ComputeExecute the Compute command on the objectvoid Compute()PublishParameterPublish or un-publish a number attribute as driving parametervoid PublishParameter(string fieldName, bool trueToPublish)PublishAllParametersToWorkbenchCall this method to expose all object's attributes so that they can be accessible and driven from Workbench.void PublishAllParametersToWorkbench(bool trueToPublish)ApplyPresetUpdate the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error.void ApplyPreset(string presetFilePath)ExportToPresetExport the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error.string ExportToPreset(string filePath)### Property

NameDescriptionSyntaxXCurvesLinks attributeSpeosDes.OpticalFeatureStyleFreestyle.OpticalFeatureStyleFreestyleXCurves XCurvesYCurvesLinks attributeSpeosDes.OpticalFeatureStyleFreestyle.OpticalFeatureStyleFreestyleYCurves YCurvesStyleOriginLink attributeSpeosDes.OpticalFeatureStyleFreestyle.OpticalFeatureStyleFreestyleStyleOrigin StyleOriginStyleAxisLink attributeSpeosDes.OpticalFeatureStyleFreestyle.OpticalFeatureStyleFreestyleStyleAxis StyleAxisReverseStyleAxisBoolean attributebool ReverseStyleAxisStyleOrientationLink attributeSpeosDes.OpticalFeatureStyleFreestyle.OpticalFeatureStyleFreestyleStyleOrientation StyleOrientationReverseStyleOrientationBoolean attributebool ReverseStyleOrientationSubjectDeprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapperSpaceClaim.Api.V242.CustomObject SubjectOccurrenceGet the underlying CustomObject occurrence, associated to the API object wrapper in current API versionobject OccurrenceNameGet or Set the name of the objectstring NameVisibleChange the visibility status (same behavior as checking/unchecking on the tree view item)bool VisibleStatusInfoGet the status of the object (warning or error message)string StatusInfoIsUpToDateAsk if the object was modified since its last successful computationbool IsUpToDate### OpticalFeatureStyleFreestyle.OpticalFeatureStyleFreestyleXCurves

### Method

NameDescriptionSyntaxSetLinks attribute: Link to an array of script objectsbool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject\[\] selectedObjects)SetLinks attribute: Link to an array of document objectsbool Set(SpaceClaim.Api.V242.IDocObject\[\] selectedObjects)SetLinks attribute: Link to an array of document objects (IDocObject type from unspecified version)bool Set(System.Object\[\] docObjectsFromPreviousVersion)ClearLinks attribute: Clear the list of linksvoid Clear()SelectAllLinks attribute: Link to all compatible objects in the active contextvoid SelectAll()### Property

NameDescriptionSyntaxLinkedObjectsLinks attribute: Get the pointed document objectsIReadOnlyCollection&lt;SpaceClaim.Api.V242.IDocObject&gt; LinkedObjectsItemLinks attribute: Get a pointed document object by indexSpaceClaim.Api.V242.IDocObject ItemCountLinks attribute: Get the links countint Count### OpticalFeatureStyleFreestyle.OpticalFeatureStyleFreestyleYCurves

### Method

NameDescriptionSyntaxSetLinks attribute: Link to an array of script objectsbool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject\[\] selectedObjects)SetLinks attribute: Link to an array of document objectsbool Set(SpaceClaim.Api.V242.IDocObject\[\] selectedObjects)SetLinks attribute: Link to an array of document objects (IDocObject type from unspecified version)bool Set(System.Object\[\] docObjectsFromPreviousVersion)ClearLinks attribute: Clear the list of linksvoid Clear()SelectAllLinks attribute: Link to all compatible objects in the active contextvoid SelectAll()### Property

NameDescriptionSyntaxLinkedObjectsLinks attribute: Get the pointed document objectsIReadOnlyCollection&lt;SpaceClaim.Api.V242.IDocObject&gt; LinkedObjectsItemLinks attribute: Get a pointed document object by indexSpaceClaim.Api.V242.IDocObject ItemCountLinks attribute: Get the links countint Count### OpticalFeatureStyleFreestyle.OpticalFeatureStyleFreestyleStyleOrigin

### Method

NameDescriptionSyntaxSetLink attribute: Set the link to a script objectbool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)SetLink attribute: Set the link to a DocObjectbool Set(SpaceClaim.Api.V242.IDocObject selectedObject)SetLink attribute: Set the link to an object (IDocObject type from unspecified version)bool Set(object docObjectFromPreviousVersion)ClearLink attribute: Clear the linkvoid Clear()### Property

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed objectSpaceClaim.Api.V242.IDocObject LinkedObject### OpticalFeatureStyleFreestyle.OpticalFeatureStyleFreestyleStyleAxis

### Method

NameDescriptionSyntaxSetLink attribute: Set the link to a script objectbool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)SetLink attribute: Set the link to a DocObjectbool Set(SpaceClaim.Api.V242.IDocObject selectedObject)SetLink attribute: Set the link to an object (IDocObject type from unspecified version)bool Set(object docObjectFromPreviousVersion)ClearLink attribute: Clear the linkvoid Clear()### Property

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed objectSpaceClaim.Api.V242.IDocObject LinkedObject### OpticalFeatureStyleFreestyle.OpticalFeatureStyleFreestyleStyleOrientation

### Method

NameDescriptionSyntaxSetLink attribute: Set the link to a script objectbool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)SetLink attribute: Set the link to a DocObjectbool Set(SpaceClaim.Api.V242.IDocObject selectedObject)SetLink attribute: Set the link to an object (IDocObject type from unspecified version)bool Set(object docObjectFromPreviousVersion)ClearLink attribute: Clear the linkvoid Clear()### Property

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed objectSpaceClaim.Api.V242.IDocObject LinkedObject## OpticalFeatureStyleHoneycomb

### Static method

NameDescriptionSyntaxFromSelectionConvert Items of a ScriptSelection to a list of Speos objects when their type is matching.IEnumerable&lt;SpeosDes.OpticalFeatureStyleHoneycomb&gt; FromSelection(IEnumerable&lt;SpaceClaim.Api.V242.IDocObject&gt; selectionItems)FindReturns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.\*")SpeosDes.OpticalFeatureStyleHoneycomb Find(string objectName)### Method

NameDescriptionSyntaxFindOccurrenceInActivePartSearch for occurrences of this object in the active Partobject FindOccurrenceInActivePart()FindOccurrenceInContextOfSearch for occurrences of this object in the specified PartSpaceClaim.Api.V242.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V242.IDocObject contextObject)ToStringGet a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable)string ToString()DeleteDelete this objectbool Delete()GetChildSubjectsRetrieve all children as DocObjectsIEnumerable&lt;SpaceClaim.Api.V242.CustomObject&gt; GetChildSubjects()GetChildrenRetrieve all direct children of a given typeIEnumerable&lt;TSpecificApiType&gt; GetChildren&lt;TSpecificApiType&gt;()ComputeExecute the Compute command on the objectvoid Compute()PublishParameterPublish or un-publish a number attribute as driving parametervoid PublishParameter(string fieldName, bool trueToPublish)PublishAllParametersToWorkbenchCall this method to expose all object's attributes so that they can be accessible and driven from Workbench.void PublishAllParametersToWorkbench(bool trueToPublish)ApplyPresetUpdate the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error.void ApplyPreset(string presetFilePath)ExportToPresetExport the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error.string ExportToPreset(string filePath)### Property

NameDescriptionSyntaxXStartNumber attributedouble XStartXStartTextNumber attribute (as text)string XStartTextXEndNumber attributedouble XEndXEndTextNumber attribute (as text)string XEndTextYStartNumber attributedouble YStartYStartTextNumber attribute (as text)string YStartTextYEndNumber attributedouble YEndYEndTextNumber attribute (as text)string YEndTextRotationNumber attributedouble RotationRotationTextNumber attribute (as text)string RotationTextDefinitionEnum attributeSpeosDes.OpticalFeatureStyleHoneycomb.EnumDefinition DefinitionDefinitionIndexEnum attribute (as index)int DefinitionIndexSideLengthNumber attributedouble SideLengthSideLengthTextNumber attribute (as text)string SideLengthTextWidthNumber attributedouble WidthWidthTextNumber attribute (as text)string WidthTextStyleOriginLink attributeSpeosDes.OpticalFeatureStyleHoneycomb.OpticalFeatureStyleHoneycombStyleOrigin StyleOriginStyleAxisLink attributeSpeosDes.OpticalFeatureStyleHoneycomb.OpticalFeatureStyleHoneycombStyleAxis StyleAxisReverseStyleAxisBoolean attributebool ReverseStyleAxisStyleOrientationLink attributeSpeosDes.OpticalFeatureStyleHoneycomb.OpticalFeatureStyleHoneycombStyleOrientation StyleOrientationReverseStyleOrientationBoolean attributebool ReverseStyleOrientationSubjectDeprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapperSpaceClaim.Api.V242.CustomObject SubjectOccurrenceGet the underlying CustomObject occurrence, associated to the API object wrapper in current API versionobject OccurrenceNameGet or Set the name of the objectstring NameVisibleChange the visibility status (same behavior as checking/unchecking on the tree view item)bool VisibleStatusInfoGet the status of the object (warning or error message)string StatusInfoIsUpToDateAsk if the object was modified since its last successful computationbool IsUpToDate### OpticalFeatureStyleHoneycomb.OpticalFeatureStyleHoneycombStyleOrigin

### Method

NameDescriptionSyntaxSetLink attribute: Set the link to a script objectbool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)SetLink attribute: Set the link to a DocObjectbool Set(SpaceClaim.Api.V242.IDocObject selectedObject)SetLink attribute: Set the link to an object (IDocObject type from unspecified version)bool Set(object docObjectFromPreviousVersion)ClearLink attribute: Clear the linkvoid Clear()### Property

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed objectSpaceClaim.Api.V242.IDocObject LinkedObject### OpticalFeatureStyleHoneycomb.OpticalFeatureStyleHoneycombStyleAxis

### Method

NameDescriptionSyntaxSetLink attribute: Set the link to a script objectbool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)SetLink attribute: Set the link to a DocObjectbool Set(SpaceClaim.Api.V242.IDocObject selectedObject)SetLink attribute: Set the link to an object (IDocObject type from unspecified version)bool Set(object docObjectFromPreviousVersion)ClearLink attribute: Clear the linkvoid Clear()### Property

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed objectSpaceClaim.Api.V242.IDocObject LinkedObject### OpticalFeatureStyleHoneycomb.OpticalFeatureStyleHoneycombStyleOrientation

### Method

NameDescriptionSyntaxSetLink attribute: Set the link to a script objectbool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)SetLink attribute: Set the link to a DocObjectbool Set(SpaceClaim.Api.V242.IDocObject selectedObject)SetLink attribute: Set the link to an object (IDocObject type from unspecified version)bool Set(object docObjectFromPreviousVersion)ClearLink attribute: Clear the linkvoid Clear()### Property

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed objectSpaceClaim.Api.V242.IDocObject LinkedObject## OpticalFeatureStyleRectangular

### Static method

NameDescriptionSyntaxFromSelectionConvert Items of a ScriptSelection to a list of Speos objects when their type is matching.IEnumerable&lt;SpeosDes.OpticalFeatureStyleRectangular&gt; FromSelection(IEnumerable&lt;SpaceClaim.Api.V242.IDocObject&gt; selectionItems)FindReturns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.\*")SpeosDes.OpticalFeatureStyleRectangular Find(string objectName)### Method

NameDescriptionSyntaxFindOccurrenceInActivePartSearch for occurrences of this object in the active Partobject FindOccurrenceInActivePart()FindOccurrenceInContextOfSearch for occurrences of this object in the specified PartSpaceClaim.Api.V242.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V242.IDocObject contextObject)ToStringGet a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable)string ToString()DeleteDelete this objectbool Delete()GetChildSubjectsRetrieve all children as DocObjectsIEnumerable&lt;SpaceClaim.Api.V242.CustomObject&gt; GetChildSubjects()GetChildrenRetrieve all direct children of a given typeIEnumerable&lt;TSpecificApiType&gt; GetChildren&lt;TSpecificApiType&gt;()ComputeExecute the Compute command on the objectvoid Compute()PublishParameterPublish or un-publish a number attribute as driving parametervoid PublishParameter(string fieldName, bool trueToPublish)PublishAllParametersToWorkbenchCall this method to expose all object's attributes so that they can be accessible and driven from Workbench.void PublishAllParametersToWorkbench(bool trueToPublish)ApplyPresetUpdate the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error.void ApplyPreset(string presetFilePath)ExportToPresetExport the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error.string ExportToPreset(string filePath)### Property

NameDescriptionSyntaxXStartNumber attributedouble XStartXStartTextNumber attribute (as text)string XStartTextXEndNumber attributedouble XEndXEndTextNumber attribute (as text)string XEndTextYStartNumber attributedouble YStartYStartTextNumber attribute (as text)string YStartTextYEndNumber attributedouble YEndYEndTextNumber attribute (as text)string YEndTextXAngleNumber attributedouble XAngleXAngleTextNumber attribute (as text)string XAngleTextYAngleNumber attributedouble YAngleYAngleTextNumber attribute (as text)string YAngleTextDefinitionEnum attributeSpeosDes.OpticalFeatureStyleRectangular.EnumDefinition DefinitionDefinitionIndexEnum attribute (as index)int DefinitionIndexXCountNumber attributeint XCountXCountTextNumber attribute (as text)string XCountTextYCountNumber attributeint YCountYCountTextNumber attribute (as text)string YCountTextXSizeNumber attributedouble XSizeXSizeTextNumber attribute (as text)string XSizeTextYSizeNumber attributedouble YSizeYSizeTextNumber attribute (as text)string YSizeTextStyleOriginLink attributeSpeosDes.OpticalFeatureStyleRectangular.OpticalFeatureStyleRectangularStyleOrigin StyleOriginStyleAxisLink attributeSpeosDes.OpticalFeatureStyleRectangular.OpticalFeatureStyleRectangularStyleAxis StyleAxisReverseStyleAxisBoolean attributebool ReverseStyleAxisStyleOrientationLink attributeSpeosDes.OpticalFeatureStyleRectangular.OpticalFeatureStyleRectangularStyleOrientation StyleOrientationReverseStyleOrientationBoolean attributebool ReverseStyleOrientationSubjectDeprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapperSpaceClaim.Api.V242.CustomObject SubjectOccurrenceGet the underlying CustomObject occurrence, associated to the API object wrapper in current API versionobject OccurrenceNameGet or Set the name of the objectstring NameVisibleChange the visibility status (same behavior as checking/unchecking on the tree view item)bool VisibleStatusInfoGet the status of the object (warning or error message)string StatusInfoIsUpToDateAsk if the object was modified since its last successful computationbool IsUpToDate### OpticalFeatureStyleRectangular.OpticalFeatureStyleRectangularStyleOrigin

### Method

NameDescriptionSyntaxSetLink attribute: Set the link to a script objectbool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)SetLink attribute: Set the link to a DocObjectbool Set(SpaceClaim.Api.V242.IDocObject selectedObject)SetLink attribute: Set the link to an object (IDocObject type from unspecified version)bool Set(object docObjectFromPreviousVersion)ClearLink attribute: Clear the linkvoid Clear()### Property

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed objectSpaceClaim.Api.V242.IDocObject LinkedObject### OpticalFeatureStyleRectangular.OpticalFeatureStyleRectangularStyleAxis

### Method

NameDescriptionSyntaxSetLink attribute: Set the link to a script objectbool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)SetLink attribute: Set the link to a DocObjectbool Set(SpaceClaim.Api.V242.IDocObject selectedObject)SetLink attribute: Set the link to an object (IDocObject type from unspecified version)bool Set(object docObjectFromPreviousVersion)ClearLink attribute: Clear the linkvoid Clear()### Property

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed objectSpaceClaim.Api.V242.IDocObject LinkedObject### OpticalFeatureStyleRectangular.OpticalFeatureStyleRectangularStyleOrientation

### Method

NameDescriptionSyntaxSetLink attribute: Set the link to a script objectbool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)SetLink attribute: Set the link to a DocObjectbool Set(SpaceClaim.Api.V242.IDocObject selectedObject)SetLink attribute: Set the link to an object (IDocObject type from unspecified version)bool Set(object docObjectFromPreviousVersion)ClearLink attribute: Clear the linkvoid Clear()### Property

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed objectSpaceClaim.Api.V242.IDocObject LinkedObject## OpticalFeatureStyleStripes

### Static method

NameDescriptionSyntaxFromSelectionConvert Items of a ScriptSelection to a list of Speos objects when their type is matching.IEnumerable&lt;SpeosDes.OpticalFeatureStyleStripes&gt; FromSelection(IEnumerable&lt;SpaceClaim.Api.V242.IDocObject&gt; selectionItems)FindReturns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.\*")SpeosDes.OpticalFeatureStyleStripes Find(string objectName)### Method

NameDescriptionSyntaxFindOccurrenceInActivePartSearch for occurrences of this object in the active Partobject FindOccurrenceInActivePart()FindOccurrenceInContextOfSearch for occurrences of this object in the specified PartSpaceClaim.Api.V242.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V242.IDocObject contextObject)ToStringGet a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable)string ToString()DeleteDelete this objectbool Delete()GetChildSubjectsRetrieve all children as DocObjectsIEnumerable&lt;SpaceClaim.Api.V242.CustomObject&gt; GetChildSubjects()GetChildrenRetrieve all direct children of a given typeIEnumerable&lt;TSpecificApiType&gt; GetChildren&lt;TSpecificApiType&gt;()ComputeExecute the Compute command on the objectvoid Compute()PublishParameterPublish or un-publish a number attribute as driving parametervoid PublishParameter(string fieldName, bool trueToPublish)PublishAllParametersToWorkbenchCall this method to expose all object's attributes so that they can be accessible and driven from Workbench.void PublishAllParametersToWorkbench(bool trueToPublish)ApplyPresetUpdate the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error.void ApplyPreset(string presetFilePath)ExportToPresetExport the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error.string ExportToPreset(string filePath)### Property

NameDescriptionSyntaxCurvesLinks attributeSpeosDes.OpticalFeatureStyleStripes.OpticalFeatureStyleStripesCurves CurvesStyleOriginLink attributeSpeosDes.OpticalFeatureStyleStripes.OpticalFeatureStyleStripesStyleOrigin StyleOriginStyleAxisLink attributeSpeosDes.OpticalFeatureStyleStripes.OpticalFeatureStyleStripesStyleAxis StyleAxisReverseStyleAxisBoolean attributebool ReverseStyleAxisStyleOrientationLink attributeSpeosDes.OpticalFeatureStyleStripes.OpticalFeatureStyleStripesStyleOrientation StyleOrientationReverseStyleOrientationBoolean attributebool ReverseStyleOrientationSubjectDeprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapperSpaceClaim.Api.V242.CustomObject SubjectOccurrenceGet the underlying CustomObject occurrence, associated to the API object wrapper in current API versionobject OccurrenceNameGet or Set the name of the objectstring NameVisibleChange the visibility status (same behavior as checking/unchecking on the tree view item)bool VisibleStatusInfoGet the status of the object (warning or error message)string StatusInfoIsUpToDateAsk if the object was modified since its last successful computationbool IsUpToDate### OpticalFeatureStyleStripes.OpticalFeatureStyleStripesCurves

### Method

NameDescriptionSyntaxSetLinks attribute: Link to an array of script objectsbool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject\[\] selectedObjects)SetLinks attribute: Link to an array of document objectsbool Set(SpaceClaim.Api.V242.IDocObject\[\] selectedObjects)SetLinks attribute: Link to an array of document objects (IDocObject type from unspecified version)bool Set(System.Object\[\] docObjectsFromPreviousVersion)ClearLinks attribute: Clear the list of linksvoid Clear()SelectAllLinks attribute: Link to all compatible objects in the active contextvoid SelectAll()### Property

NameDescriptionSyntaxLinkedObjectsLinks attribute: Get the pointed document objectsIReadOnlyCollection&lt;SpaceClaim.Api.V242.IDocObject&gt; LinkedObjectsItemLinks attribute: Get a pointed document object by indexSpaceClaim.Api.V242.IDocObject ItemCountLinks attribute: Get the links countint Count### OpticalFeatureStyleStripes.OpticalFeatureStyleStripesStyleOrigin

### Method

NameDescriptionSyntaxSetLink attribute: Set the link to a script objectbool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)SetLink attribute: Set the link to a DocObjectbool Set(SpaceClaim.Api.V242.IDocObject selectedObject)SetLink attribute: Set the link to an object (IDocObject type from unspecified version)bool Set(object docObjectFromPreviousVersion)ClearLink attribute: Clear the linkvoid Clear()### Property

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed objectSpaceClaim.Api.V242.IDocObject LinkedObject### OpticalFeatureStyleStripes.OpticalFeatureStyleStripesStyleAxis

### Method

NameDescriptionSyntaxSetLink attribute: Set the link to a script objectbool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)SetLink attribute: Set the link to a DocObjectbool Set(SpaceClaim.Api.V242.IDocObject selectedObject)SetLink attribute: Set the link to an object (IDocObject type from unspecified version)bool Set(object docObjectFromPreviousVersion)ClearLink attribute: Clear the linkvoid Clear()### Property

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed objectSpaceClaim.Api.V242.IDocObject LinkedObject### OpticalFeatureStyleStripes.OpticalFeatureStyleStripesStyleOrientation

### Method

NameDescriptionSyntaxSetLink attribute: Set the link to a script objectbool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)SetLink attribute: Set the link to a DocObjectbool Set(SpaceClaim.Api.V242.IDocObject selectedObject)SetLink attribute: Set the link to an object (IDocObject type from unspecified version)bool Set(object docObjectFromPreviousVersion)ClearLink attribute: Clear the linkvoid Clear()### Property

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed objectSpaceClaim.Api.V242.IDocObject LinkedObject## OpticalGroup

### Method

NameDescriptionSyntaxAddFaceFromCoordinatesvoid AddFaceFromCoordinates(int xCoordinate, int yCoordinate)AddFacesFromXCoordinatevoid AddFacesFromXCoordinate(int xCoordinate)AddFacesFromYCoordinatevoid AddFacesFromYCoordinate(int yCoordinate)GetGroupTypePossibleValuesString list attribute: List possible valuesIEnumerable GetGroupTypePossibleValues()FindOccurrenceInActivePartSearch for occurrences of this object in the active Partobject FindOccurrenceInActivePart()FindOccurrenceInContextOfSearch for occurrences of this object in the specified PartSpaceClaim.Api.V242.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V242.IDocObject contextObject)ToStringGet a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable)string ToString()DeleteDelete this objectbool Delete()GetChildSubjectsRetrieve all children as DocObjectsIEnumerable&lt;SpaceClaim.Api.V242.CustomObject&gt; GetChildSubjects()GetChildrenRetrieve all direct children of a given typeIEnumerable&lt;TSpecificApiType&gt; GetChildren&lt;TSpecificApiType&gt;()ComputeExecute the Compute command on the objectvoid Compute()PublishParameterPublish or un-publish a number attribute as driving parametervoid PublishParameter(string fieldName, bool trueToPublish)PublishAllParametersToWorkbenchCall this method to expose all object's attributes so that they can be accessible and driven from Workbench.void PublishAllParametersToWorkbench(bool trueToPublish)ApplyPresetUpdate the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error.void ApplyPreset(string presetFilePath)ExportToPresetExport the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error.string ExportToPreset(string filePath)### Static method

NameDescriptionSyntaxFromSelectionConvert Items of a ScriptSelection to a list of Speos objects when their type is matching.IEnumerable&lt;SpeosDes.OpticalGroup&gt; FromSelection(IEnumerable&lt;SpaceClaim.Api.V242.IDocObject&gt; selectionItems)FindReturns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.\*")SpeosDes.OpticalGroup Find(string objectName)### Property

NameDescriptionSyntaxShiftNumber attributedouble ShiftShiftTextNumber attribute (as text)string ShiftTextGeometryOrientationEnum attributeSpeosDes.OpticalGroup.EnumGeometryOrientation GeometryOrientationGeometryOrientationIndexEnum attribute (as index)int GeometryOrientationIndexFocalNumber attributedouble FocalFocalTextNumber attribute (as text)string FocalTextParabolicApproximationBoolean attributebool ParabolicApproximationXTiltAngleNumber attributedouble XTiltAngleXTiltAngleTextNumber attribute (as text)string XTiltAngleTextYTiltAngleNumber attributedouble YTiltAngleYTiltAngleTextNumber attribute (as text)string YTiltAngleTextAngleNumber attributedouble AngleAngleTextNumber attribute (as text)string AngleTextXRadiusNumber attributedouble XRadiusXRadiusTextNumber attribute (as text)string XRadiusTextYRadiusNumber attributedouble YRadiusYRadiusTextNumber attribute (as text)string YRadiusTextRadialRadiusNumber attributedouble RadialRadiusRadialRadiusTextNumber attribute (as text)string RadialRadiusTextStartRadiusNumber attributedouble StartRadiusStartRadiusTextNumber attribute (as text)string StartRadiusTextEndRadiusNumber attributedouble EndRadiusEndRadiusTextNumber attribute (as text)string EndRadiusTextRadiusNumber attributedouble RadiusRadiusTextNumber attribute (as text)string RadiusTextXStartNumber attributedouble XStartXStartTextNumber attribute (as text)string XStartTextXEndNumber attributedouble XEndXEndTextNumber attribute (as text)string XEndTextYStartNumber attributedouble YStartYStartTextNumber attribute (as text)string YStartTextYEndNumber attributedouble YEndYEndTextNumber attribute (as text)string YEndTextCenteredOnXSpreadBoolean attributebool CenteredOnXSpreadCenteredOnYSpreadBoolean attributebool CenteredOnYSpreadSmoothingSectorBoolean attributebool SmoothingSectorXCenterNumber attributedouble XCenterXCenterTextNumber attribute (as text)string XCenterTextYCenterNumber attributedouble YCenterYCenterTextNumber attribute (as text)string YCenterTextSpreadStartNumber attributedouble SpreadStartSpreadStartTextNumber attribute (as text)string SpreadStartTextSpreadEndNumber attributedouble SpreadEndSpreadEndTextNumber attribute (as text)string SpreadEndTextTiltNumber attributedouble TiltTiltTextNumber attribute (as text)string TiltTextYSizeNumber attributedouble YSizeYSizeTextNumber attribute (as text)string YSizeTextXAngleNumber attributedouble XAngleXAngleTextNumber attribute (as text)string XAngleTextXPositionNumber attributedouble XPositionXPositionTextNumber attribute (as text)string XPositionTextXPositionMinNumber attributedouble XPositionMinXPositionMinTextNumber attribute (as text)string XPositionMinTextXPositionMaxNumber attributedouble XPositionMaxXPositionMaxTextNumber attribute (as text)string XPositionMaxTextXAngleMinNumber attributedouble XAngleMinXAngleMinTextNumber attribute (as text)string XAngleMinTextXAngleMaxNumber attributedouble XAngleMaxXAngleMaxTextNumber attribute (as text)string XAngleMaxTextYAngleNumber attributedouble YAngleYAngleTextNumber attribute (as text)string YAngleTextYPositionNumber attributedouble YPositionYPositionTextNumber attribute (as text)string YPositionTextYPositionMinNumber attributedouble YPositionMinYPositionMinTextNumber attribute (as text)string YPositionMinTextYPositionMaxNumber attributedouble YPositionMaxYPositionMaxTextNumber attribute (as text)string YPositionMaxTextYAngleMinNumber attributedouble YAngleMinYAngleMinTextNumber attribute (as text)string YAngleMinTextYAngleMaxNumber attributedouble YAngleMaxYAngleMaxTextNumber attribute (as text)string YAngleMaxTextXSpreadNumber attributedouble XSpreadXSpreadTextNumber attribute (as text)string XSpreadTextYSpreadNumber attributedouble YSpreadYSpreadTextNumber attribute (as text)string YSpreadTextAdvancedModeBoolean attributebool AdvancedModeSCOHControlPlanesChildren attributeSpeosDes.OpticalGroup.OpticalGroupSCOHControlPlanes SCOHControlPlanesSCOVControlPlanesChildren attributeSpeosDes.OpticalGroup.OpticalGroupSCOVControlPlanes SCOVControlPlanesStartAngleNumber attributedouble StartAngleStartAngleTextNumber attribute (as text)string StartAngleTextEndAngleNumber attributedouble EndAngleEndAngleTextNumber attribute (as text)string EndAngleTextXRadiusPrismNumber attributedouble XRadiusPrismXRadiusPrismTextNumber attribute (as text)string XRadiusPrismTextYRadiusPrismNumber attributedouble YRadiusPrismYRadiusPrismTextNumber attribute (as text)string YRadiusPrismTextHeightNumber attributedouble HeightHeightTextNumber attribute (as text)string HeightTextFaceListLinks attributeSpeosDes.OpticalGroup.OpticalGroupFaceList FaceListGroupTypeString list selection attributestring GroupTypeSubjectDeprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapperSpaceClaim.Api.V242.CustomObject SubjectOccurrenceGet the underlying CustomObject occurrence, associated to the API object wrapper in current API versionobject OccurrenceNameGet or Set the name of the objectstring NameVisibleChange the visibility status (same behavior as checking/unchecking on the tree view item)bool VisibleStatusInfoGet the status of the object (warning or error message)string StatusInfoIsUpToDateAsk if the object was modified since its last successful computationbool IsUpToDate### `OpticalGroup.OpticalGroupSCOHControlPlanes`

### Method

NameDescriptionSyntaxSetChildren attribute: Set from an array of script objectsbool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject\[\] selectedObjects)SetChildren attribute: Set from an array of document objectsbool Set(SpaceClaim.Api.V242.IDocObject\[\] selectedObjects)SetChildren attribute: Set from an array of objects (IDocObject type from unspecified version)bool Set(System.Object\[\] docObjectsFromPreviousVersion)GetEnumeratorChildren attribute: Get children enumerationIEnumerator&lt;SpeosDes.ControlPlane&gt; GetEnumerator()AddNewChildren attribute: Create a new child objectSpeosDes.ControlPlane AddNew(int insertIndex)DeleteChildren attribute: Delete a child object by indexbool Delete(int index)ClearChildren attribute: Empty the listvoid Clear()SelectAllChildren attribute: Create children for all objects that are compatible with link selection.void SelectAll()### Property

NameDescriptionSyntaxLinkedObjectsChildren attribute: Get linked objectsIReadOnlyCollection&lt;SpaceClaim.Api.V242.IDocObject&gt; LinkedObjectsCountChildren attribute: Get children countint CountListChildren attribute: Get children collectionIReadOnlyCollection&lt;SpeosDes.ControlPlane&gt; ListItemChildren attribute: Get child by indexSpeosDes.ControlPlane Item### OpticalGroup.OpticalGroupSCOVControlPlanes

### Method

NameDescriptionSyntaxSetChildren attribute: Set from an array of script objectsbool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject\[\] selectedObjects)SetChildren attribute: Set from an array of document objectsbool Set(SpaceClaim.Api.V242.IDocObject\[\] selectedObjects)SetChildren attribute: Set from an array of objects (IDocObject type from unspecified version)bool Set(System.Object\[\] docObjectsFromPreviousVersion)GetEnumeratorChildren attribute: Get children enumerationIEnumerator&lt;SpeosDes.ControlPlane&gt; GetEnumerator()AddNewChildren attribute: Create a new child objectSpeosDes.ControlPlane AddNew(int insertIndex)DeleteChildren attribute: Delete a child object by indexbool Delete(int index)ClearChildren attribute: Empty the listvoid Clear()SelectAllChildren attribute: Create children for all objects that are compatible with link selection.void SelectAll()### Property

NameDescriptionSyntaxLinkedObjectsChildren attribute: Get linked objectsIReadOnlyCollection&lt;SpaceClaim.Api.V242.IDocObject&gt; LinkedObjectsCountChildren attribute: Get children countint CountListChildren attribute: Get children collectionIReadOnlyCollection&lt;SpeosDes.ControlPlane&gt; ListItemChildren attribute: Get child by indexSpeosDes.ControlPlane Item### OpticalGroup.OpticalGroupFaceList

### Method

NameDescriptionSyntaxSetLinks attribute: Link to an array of script objectsbool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject\[\] selectedObjects)SetLinks attribute: Link to an array of document objectsbool Set(SpaceClaim.Api.V242.IDocObject\[\] selectedObjects)SetLinks attribute: Link to an array of document objects (IDocObject type from unspecified version)bool Set(System.Object\[\] docObjectsFromPreviousVersion)ClearLinks attribute: Clear the list of linksvoid Clear()SelectAllLinks attribute: Link to all compatible objects in the active contextvoid SelectAll()### Property

NameDescriptionSyntaxLinkedObjectsLinks attribute: Get the pointed document objectsIReadOnlyCollection&lt;SpaceClaim.Api.V242.IDocObject&gt; LinkedObjectsItemLinks attribute: Get a pointed document object by indexSpaceClaim.Api.V242.IDocObject ItemCountLinks attribute: Get the links countint Count## ParabolicSurface

### Static method

NameDescriptionSyntaxFromSelectionConvert Items of a ScriptSelection to a list of Speos objects when their type is matching.IEnumerable&lt;SpeosDes.ParabolicSurface&gt; FromSelection(IEnumerable&lt;SpaceClaim.Api.V242.IDocObject&gt; selectionItems)FindReturns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.\*")SpeosDes.ParabolicSurface Find(string objectName)CreateCreate a new object of this type under the specified parent componentSpeosDes.ParabolicSurface Create(object parent)CreateCreate a new object in the active contextSpeosDes.ParabolicSurface Create()### Method

NameDescriptionSyntaxCloneCreate a copy of this object in the active contextSpeosDes.ParabolicSurface Clone()CopyToCreate a copy of this object and paste it to the specified destinationSpeosDes.ParabolicSurface CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)FindOccurrenceInActivePartSearch for occurrences of this object in the active Partobject FindOccurrenceInActivePart()FindOccurrenceInContextOfSearch for occurrences of this object in the specified PartSpaceClaim.Api.V242.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V242.IDocObject contextObject)ToStringGet a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable)string ToString()DeleteDelete this objectbool Delete()GetChildSubjectsRetrieve all children as DocObjectsIEnumerable&lt;SpaceClaim.Api.V242.CustomObject&gt; GetChildSubjects()GetChildrenRetrieve all direct children of a given typeIEnumerable&lt;TSpecificApiType&gt; GetChildren&lt;TSpecificApiType&gt;()ComputeExecute the Compute command on the objectvoid Compute()PublishParameterPublish or un-publish a number attribute as driving parametervoid PublishParameter(string fieldName, bool trueToPublish)PublishAllParametersToWorkbenchCall this method to expose all object's attributes so that they can be accessible and driven from Workbench.void PublishAllParametersToWorkbench(bool trueToPublish)ApplyPresetUpdate the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error.void ApplyPreset(string presetFilePath)ExportToPresetExport the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error.string ExportToPreset(string filePath)### Property

NameDescriptionSyntaxOriginPointLink attributeSpeosDes.ParabolicSurface.ParabolicSurfaceOriginPoint OriginPointAxisLink attributeSpeosDes.ParabolicSurface.ParabolicSurfaceAxis AxisOrientationAxisLink attributeSpeosDes.ParabolicSurface.ParabolicSurfaceOrientationAxis OrientationAxisSizeNumber attributedouble SizeSizeTextNumber attribute (as text)string SizeTextBuildTypeEnum attributeSpeosDes.ParabolicSurface.EnumBuildType BuildTypeBuildTypeIndexEnum attribute (as index)int BuildTypeIndexFocalNumber attributedouble FocalFocalTextNumber attribute (as text)string FocalTextFocalOutNumber attributedouble FocalOutFocalOutTextNumber attribute (as text)string FocalOutTextPassingPointLink attributeSpeosDes.ParabolicSurface.ParabolicSurfacePassingPoint PassingPointReverseOpticalAxisBoolean attributebool ReverseOpticalAxisSubjectDeprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapperSpaceClaim.Api.V242.CustomObject SubjectOccurrenceGet the underlying CustomObject occurrence, associated to the API object wrapper in current API versionobject OccurrenceNameGet or Set the name of the objectstring NameVisibleChange the visibility status (same behavior as checking/unchecking on the tree view item)bool VisibleStatusInfoGet the status of the object (warning or error message)string StatusInfoIsUpToDateAsk if the object was modified since its last successful computationbool IsUpToDate### ParabolicSurface.ParabolicSurfaceOriginPoint

### Method

NameDescriptionSyntaxSetLink attribute: Set the link to a script objectbool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)SetLink attribute: Set the link to a DocObjectbool Set(SpaceClaim.Api.V242.IDocObject selectedObject)SetLink attribute: Set the link to an object (IDocObject type from unspecified version)bool Set(object docObjectFromPreviousVersion)ClearLink attribute: Clear the linkvoid Clear()### Property

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed objectSpaceClaim.Api.V242.IDocObject LinkedObject### ParabolicSurface.ParabolicSurfaceAxis

### Method

NameDescriptionSyntaxSetLink attribute: Set the link to a script objectbool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)SetLink attribute: Set the link to a DocObjectbool Set(SpaceClaim.Api.V242.IDocObject selectedObject)SetLink attribute: Set the link to an object (IDocObject type from unspecified version)bool Set(object docObjectFromPreviousVersion)ClearLink attribute: Clear the linkvoid Clear()### Property

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed objectSpaceClaim.Api.V242.IDocObject LinkedObject### ParabolicSurface.ParabolicSurfaceOrientationAxis

### Method

NameDescriptionSyntaxSetLink attribute: Set the link to a script objectbool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)SetLink attribute: Set the link to a DocObjectbool Set(SpaceClaim.Api.V242.IDocObject selectedObject)SetLink attribute: Set the link to an object (IDocObject type from unspecified version)bool Set(object docObjectFromPreviousVersion)ClearLink attribute: Clear the linkvoid Clear()### Property

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed objectSpaceClaim.Api.V242.IDocObject LinkedObject### ParabolicSurface.ParabolicSurfacePassingPoint

### Method

NameDescriptionSyntaxSetLink attribute: Set the link to a script objectbool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)SetLink attribute: Set the link to a DocObjectbool Set(SpaceClaim.Api.V242.IDocObject selectedObject)SetLink attribute: Set the link to an object (IDocObject type from unspecified version)bool Set(object docObjectFromPreviousVersion)ClearLink attribute: Clear the linkvoid Clear()### Property

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed objectSpaceClaim.Api.V242.IDocObject LinkedObject## PER

### Static method

NameDescriptionSyntaxFromSelectionConvert Items of a ScriptSelection to a list of Speos objects when their type is matching.IEnumerable&lt;SpeosDes.PER&gt; FromSelection(IEnumerable&lt;SpaceClaim.Api.V242.IDocObject&gt; selectionItems)FindReturns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.\*")SpeosDes.PER Find(string objectName)CreateCreate a new object of this type under the specified parent componentSpeosDes.PER Create(object parent)CreateCreate a new object in the active contextSpeosDes.PER Create()### Method

NameDescriptionSyntaxCloneCreate a copy of this object in the active contextSpeosDes.PER Clone()CopyToCreate a copy of this object and paste it to the specified destinationSpeosDes.PER CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)FindOccurrenceInActivePartSearch for occurrences of this object in the active Partobject FindOccurrenceInActivePart()FindOccurrenceInContextOfSearch for occurrences of this object in the specified PartSpaceClaim.Api.V242.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V242.IDocObject contextObject)ToStringGet a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable)string ToString()DeleteDelete this objectbool Delete()GetChildSubjectsRetrieve all children as DocObjectsIEnumerable&lt;SpaceClaim.Api.V242.CustomObject&gt; GetChildSubjects()GetChildrenRetrieve all direct children of a given typeIEnumerable&lt;TSpecificApiType&gt; GetChildren&lt;TSpecificApiType&gt;()ComputeExecute the Compute command on the objectvoid Compute()PublishParameterPublish or un-publish a number attribute as driving parametervoid PublishParameter(string fieldName, bool trueToPublish)PublishAllParametersToWorkbenchCall this method to expose all object's attributes so that they can be accessible and driven from Workbench.void PublishAllParametersToWorkbench(bool trueToPublish)ApplyPresetUpdate the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error.void ApplyPreset(string presetFilePath)ExportToPresetExport the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error.string ExportToPreset(string filePath)### Property

NameDescriptionSyntaxSourceTypeEnum attributeSpeosDes.PER.EnumSourceType SourceTypeSourceTypeIndexEnum attribute (as index)int SourceTypeIndexSourcePointLink attributeSpeosDes.PER.PERSourcePoint SourcePointSourceSupportLink attributeSpeosDes.PER.PERSourceSupport SourceSupportImagePointLink attributeSpeosDes.PER.PERImagePoint ImagePointOrientationAxisLink attributeSpeosDes.PER.PEROrientationAxis OrientationAxisReverseOrientationAxisDirectionBoolean attributebool ReverseOrientationAxisDirectionFocalLengthNumber attributedouble FocalLengthFocalLengthTextNumber attribute (as text)string FocalLengthTextHoleBoolean attributebool HoleHoleDiameterNumber attributedouble HoleDiameterHoleDiameterTextNumber attribute (as text)string HoleDiameterTextSymmetryEnum attributeSpeosDes.PER.EnumSymmetry SymmetrySymmetryIndexEnum attribute (as index)int SymmetryIndexAngularSectionsChildren CustomObjects attributeSpeosDes.PER.PERAngularSections AngularSectionsSubjectDeprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapperSpaceClaim.Api.V242.CustomObject SubjectOccurrenceGet the underlying CustomObject occurrence, associated to the API object wrapper in current API versionobject OccurrenceNameGet or Set the name of the objectstring NameVisibleChange the visibility status (same behavior as checking/unchecking on the tree view item)bool VisibleStatusInfoGet the status of the object (warning or error message)string StatusInfoIsUpToDateAsk if the object was modified since its last successful computationbool IsUpToDate### PER.PERSourcePoint

### Method

NameDescriptionSyntaxSetLink attribute: Set the link to a script objectbool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)SetLink attribute: Set the link to a DocObjectbool Set(SpaceClaim.Api.V242.IDocObject selectedObject)SetLink attribute: Set the link to an object (IDocObject type from unspecified version)bool Set(object docObjectFromPreviousVersion)ClearLink attribute: Clear the linkvoid Clear()### Property

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed objectSpaceClaim.Api.V242.IDocObject LinkedObject### PER.PERSourceSupport

### Method

NameDescriptionSyntaxSetLink attribute: Set the link to a script objectbool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)SetLink attribute: Set the link to a DocObjectbool Set(SpaceClaim.Api.V242.IDocObject selectedObject)SetLink attribute: Set the link to an object (IDocObject type from unspecified version)bool Set(object docObjectFromPreviousVersion)ClearLink attribute: Clear the linkvoid Clear()### Property

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed objectSpaceClaim.Api.V242.IDocObject LinkedObject### PER.PERImagePoint

### Method

NameDescriptionSyntaxSetLink attribute: Set the link to a script objectbool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)SetLink attribute: Set the link to a DocObjectbool Set(SpaceClaim.Api.V242.IDocObject selectedObject)SetLink attribute: Set the link to an object (IDocObject type from unspecified version)bool Set(object docObjectFromPreviousVersion)ClearLink attribute: Clear the linkvoid Clear()### Property

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed objectSpaceClaim.Api.V242.IDocObject LinkedObject### PER.PEROrientationAxis

### Method

NameDescriptionSyntaxSetLink attribute: Set the link to a script objectbool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)SetLink attribute: Set the link to a DocObjectbool Set(SpaceClaim.Api.V242.IDocObject selectedObject)SetLink attribute: Set the link to an object (IDocObject type from unspecified version)bool Set(object docObjectFromPreviousVersion)ClearLink attribute: Clear the linkvoid Clear()### Property

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed objectSpaceClaim.Api.V242.IDocObject LinkedObject### PER.PERAngularSections

### Method

NameDescriptionSyntaxGetEnumeratorGet children CustomObjects enumerationIEnumerator&lt;SpeosDes.PERAngularSection&gt; GetEnumerator()AddNewCreate a new child CustomObjectSpeosDes.PERAngularSection AddNew(int insertIndex)DeleteDelete a child CustomObject by indexvoid Delete(int index)### Property

NameDescriptionSyntaxCountGet children CustomObjects countint CountListGet children CustomObjects listIReadOnlyCollection&lt;SpeosDes.PERAngularSection&gt; ListItemGet child CustomObject by indexSpeosDes.PERAngularSection ItemItemGet child CustomObject by indexSpeosDes.PERAngularSection Item## PERAngularSection

### Static method

NameDescriptionSyntaxFromSelectionConvert Items of a ScriptSelection to a list of Speos objects when their type is matching.IEnumerable&lt;SpeosDes.PERAngularSection&gt; FromSelection(IEnumerable&lt;SpaceClaim.Api.V242.IDocObject&gt; selectionItems)FindReturns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.\*")SpeosDes.PERAngularSection Find(string objectName)### Method

NameDescriptionSyntaxFittingControlPlaneCall the 'Fitting control plane' command. Returns 'false' if this action is unavailable in the current state of the object.bool FittingControlPlane()FindOccurrenceInActivePartSearch for occurrences of this object in the active Partobject FindOccurrenceInActivePart()FindOccurrenceInContextOfSearch for occurrences of this object in the specified PartSpaceClaim.Api.V242.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V242.IDocObject contextObject)ToStringGet a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable)string ToString()DeleteDelete this objectbool Delete()GetChildSubjectsRetrieve all children as DocObjectsIEnumerable&lt;SpaceClaim.Api.V242.CustomObject&gt; GetChildSubjects()GetChildrenRetrieve all direct children of a given typeIEnumerable&lt;TSpecificApiType&gt; GetChildren&lt;TSpecificApiType&gt;()ComputeExecute the Compute command on the objectvoid Compute()PublishParameterPublish or un-publish a number attribute as driving parametervoid PublishParameter(string fieldName, bool trueToPublish)PublishAllParametersToWorkbenchCall this method to expose all object's attributes so that they can be accessible and driven from Workbench.void PublishAllParametersToWorkbench(bool trueToPublish)ApplyPresetUpdate the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error.void ApplyPreset(string presetFilePath)ExportToPresetExport the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error.string ExportToPreset(string filePath)### Property

NameDescriptionSyntaxAngleNumber attributedouble AngleAngleTextNumber attribute (as text)string AngleTextControlPlanesChildren attributeSpeosDes.PERAngularSection.PERAngularSectionControlPlanes ControlPlanesSubjectDeprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapperSpaceClaim.Api.V242.CustomObject SubjectOccurrenceGet the underlying CustomObject occurrence, associated to the API object wrapper in current API versionobject OccurrenceNameGet or Set the name of the objectstring NameVisibleChange the visibility status (same behavior as checking/unchecking on the tree view item)bool VisibleStatusInfoGet the status of the object (warning or error message)string StatusInfoIsUpToDateAsk if the object was modified since its last successful computationbool IsUpToDate### PERAngularSection.PERAngularSectionControlPlanes

### Method

NameDescriptionSyntaxSetChildren attribute: Set from an array of script objectsbool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject\[\] selectedObjects)SetChildren attribute: Set from an array of document objectsbool Set(SpaceClaim.Api.V242.IDocObject\[\] selectedObjects)SetChildren attribute: Set from an array of objects (IDocObject type from unspecified version)bool Set(System.Object\[\] docObjectsFromPreviousVersion)GetEnumeratorChildren attribute: Get children enumerationIEnumerator&lt;SpeosDes.ControlPlane&gt; GetEnumerator()AddNewChildren attribute: Create a new child objectSpeosDes.ControlPlane AddNew(int insertIndex)DeleteChildren attribute: Delete a child object by indexbool Delete(int index)ClearChildren attribute: Empty the listvoid Clear()SelectAllChildren attribute: Create children for all objects that are compatible with link selection.void SelectAll()### Property

NameDescriptionSyntaxLinkedObjectsChildren attribute: Get linked objectsIReadOnlyCollection&lt;SpaceClaim.Api.V242.IDocObject&gt; LinkedObjectsCountChildren attribute: Get children countint CountListChildren attribute: Get children collectionIReadOnlyCollection&lt;SpeosDes.ControlPlane&gt; ListItemChildren attribute: Get child by indexSpeosDes.ControlPlane Item## PostProcessing

### Static method

NameDescriptionSyntaxFromSelectionConvert Items of a ScriptSelection to a list of Speos objects when their type is matching.IEnumerable&lt;SpeosDes.PostProcessing&gt; FromSelection(IEnumerable&lt;SpaceClaim.Api.V242.IDocObject&gt; selectionItems)FindReturns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.\*")SpeosDes.PostProcessing Find(string objectName)CreateCreate a new object of this type under the specified parent componentSpeosDes.PostProcessing Create(object parent)CreateCreate a new object in the active contextSpeosDes.PostProcessing Create()### Method

NameDescriptionSyntaxCloneCreate a copy of this object in the active contextSpeosDes.PostProcessing Clone()CopyToCreate a copy of this object and paste it to the specified destinationSpeosDes.PostProcessing CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)FindOccurrenceInActivePartSearch for occurrences of this object in the active Partobject FindOccurrenceInActivePart()FindOccurrenceInContextOfSearch for occurrences of this object in the specified PartSpaceClaim.Api.V242.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V242.IDocObject contextObject)ToStringGet a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable)string ToString()DeleteDelete this objectbool Delete()GetChildSubjectsRetrieve all children as DocObjectsIEnumerable&lt;SpaceClaim.Api.V242.CustomObject&gt; GetChildSubjects()GetChildrenRetrieve all direct children of a given typeIEnumerable&lt;TSpecificApiType&gt; GetChildren&lt;TSpecificApiType&gt;()ComputeExecute the Compute command on the objectvoid Compute()PublishParameterPublish or un-publish a number attribute as driving parametervoid PublishParameter(string fieldName, bool trueToPublish)PublishAllParametersToWorkbenchCall this method to expose all object's attributes so that they can be accessible and driven from Workbench.void PublishAllParametersToWorkbench(bool trueToPublish)ApplyPresetUpdate the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error.void ApplyPreset(string presetFilePath)ExportToPresetExport the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error.string ExportToPreset(string filePath)### Property

NameDescriptionSyntaxAssociatedFeatureLink attributeSpeosDes.PostProcessing.PostProcessingAssociatedFeature AssociatedFeatureSubjectDeprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapperSpaceClaim.Api.V242.CustomObject SubjectOccurrenceGet the underlying CustomObject occurrence, associated to the API object wrapper in current API versionobject OccurrenceNameGet or Set the name of the objectstring NameVisibleChange the visibility status (same behavior as checking/unchecking on the tree view item)bool VisibleStatusInfoGet the status of the object (warning or error message)string StatusInfoIsUpToDateAsk if the object was modified since its last successful computationbool IsUpToDate### PostProcessing.PostProcessingAssociatedFeature

### Method

NameDescriptionSyntaxSetLink attribute: Set the link to a script objectbool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)SetLink attribute: Set the link to a DocObjectbool Set(SpaceClaim.Api.V242.IDocObject selectedObject)SetLink attribute: Set the link to an object (IDocObject type from unspecified version)bool Set(object docObjectFromPreviousVersion)ClearLink attribute: Clear the linkvoid Clear()### Property

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed objectSpaceClaim.Api.V242.IDocObject LinkedObject## ProjectionLens

### Static method

NameDescriptionSyntaxFromSelectionConvert Items of a ScriptSelection to a list of Speos objects when their type is matching.IEnumerable&lt;SpeosDes.ProjectionLens&gt; FromSelection(IEnumerable&lt;SpaceClaim.Api.V242.IDocObject&gt; selectionItems)FindReturns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.\*")SpeosDes.ProjectionLens Find(string objectName)CreateCreate a new object of this type under the specified parent componentSpeosDes.ProjectionLens Create(object parent)CreateCreate a new object in the active contextSpeosDes.ProjectionLens Create()### Method

NameDescriptionSyntaxCloneCreate a copy of this object in the active contextSpeosDes.ProjectionLens Clone()CopyToCreate a copy of this object and paste it to the specified destinationSpeosDes.ProjectionLens CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)FindOccurrenceInActivePartSearch for occurrences of this object in the active Partobject FindOccurrenceInActivePart()FindOccurrenceInContextOfSearch for occurrences of this object in the specified PartSpaceClaim.Api.V242.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V242.IDocObject contextObject)ToStringGet a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable)string ToString()DeleteDelete this objectbool Delete()GetChildSubjectsRetrieve all children as DocObjectsIEnumerable&lt;SpaceClaim.Api.V242.CustomObject&gt; GetChildSubjects()GetChildrenRetrieve all direct children of a given typeIEnumerable&lt;TSpecificApiType&gt; GetChildren&lt;TSpecificApiType&gt;()ComputeExecute the Compute command on the objectvoid Compute()PublishParameterPublish or un-publish a number attribute as driving parametervoid PublishParameter(string fieldName, bool trueToPublish)PublishAllParametersToWorkbenchCall this method to expose all object's attributes so that they can be accessible and driven from Workbench.void PublishAllParametersToWorkbench(bool trueToPublish)ApplyPresetUpdate the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error.void ApplyPreset(string presetFilePath)ExportToPresetExport the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error.string ExportToPreset(string filePath)### Property

NameDescriptionSyntaxFocalPointLink attributeSpeosDes.ProjectionLens.ProjectionLensFocalPoint FocalPointOpticalAxisLink attributeSpeosDes.ProjectionLens.ProjectionLensOpticalAxis OpticalAxisOpticalAxisReverseBoolean attributebool OpticalAxisReverseBackFocalLengthNumber attributedouble BackFocalLengthBackFocalLengthTextNumber attribute (as text)string BackFocalLengthTextBackFaceTypeEnum attributeSpeosDes.ProjectionLens.EnumBackFaceType BackFaceTypeBackFaceTypeIndexEnum attribute (as index)int BackFaceTypeIndexFrontFaceTypeEnum attributeSpeosDes.ProjectionLens.EnumFrontFaceType FrontFaceTypeFrontFaceTypeIndexEnum attribute (as index)int FrontFaceTypeIndexZernikeOrientationLink attributeSpeosDes.ProjectionLens.ProjectionLensZernikeOrientation ZernikeOrientationZernikeOrientationReverseBoolean attributebool ZernikeOrientationReverseThicknessSetTypeEnum attributeSpeosDes.ProjectionLens.EnumThicknessSetType ThicknessSetTypeThicknessSetTypeIndexEnum attribute (as index)int ThicknessSetTypeIndexEdgeThicknessNumber attributedouble EdgeThicknessEdgeThicknessTextNumber attribute (as text)string EdgeThicknessTextEdgeThicknessOutNumber attributedouble EdgeThicknessOutEdgeThicknessOutTextNumber attribute (as text)string EdgeThicknessOutTextLensThicknessNumber attributedouble LensThicknessLensThicknessTextNumber attribute (as text)string LensThicknessTextLensThicknessOutNumber attributedouble LensThicknessOutLensThicknessOutTextNumber attribute (as text)string LensThicknessOutTextConstructionTypeEnum attributeSpeosDes.ProjectionLens.EnumConstructionType ConstructionTypeConstructionTypeIndexEnum attribute (as index)int ConstructionTypeIndexCustomRevolutionBoolean attributebool CustomRevolutionRevolutionOriginPointLink attributeSpeosDes.ProjectionLens.ProjectionLensRevolutionOriginPoint RevolutionOriginPointRevolutionAxisLink attributeSpeosDes.ProjectionLens.ProjectionLensRevolutionAxis RevolutionAxisRevolutionAxisReverseBoolean attributebool RevolutionAxisReverseExtrusionAxisLink attributeSpeosDes.ProjectionLens.ProjectionLensExtrusionAxis ExtrusionAxisExtrusionAxisReverseBoolean attributebool ExtrusionAxisReverseExtrusionStartNumber attributedouble ExtrusionStartExtrusionStartTextNumber attribute (as text)string ExtrusionStartTextExtrusionEndNumber attributedouble ExtrusionEndExtrusionEndTextNumber attribute (as text)string ExtrusionEndTextRevolutionStartNumber attributedouble RevolutionStartRevolutionStartTextNumber attribute (as text)string RevolutionStartTextRevolutionEndNumber attributedouble RevolutionEndRevolutionEndTextNumber attribute (as text)string RevolutionEndTextBackFaceApertureDiameterNumber attributedouble BackFaceApertureDiameterBackFaceApertureDiameterTextNumber attribute (as text)string BackFaceApertureDiameterTextBackRadiusCurvatureNumber attributedouble BackRadiusCurvatureBackRadiusCurvatureTextNumber attribute (as text)string BackRadiusCurvatureTextBackConicConstantNumber attributedouble BackConicConstantBackConicConstantTextNumber attribute (as text)string BackConicConstantTextBackFaceRefractiveIndexNumber attributedouble BackFaceRefractiveIndexBackFaceRefractiveIndexTextNumber attribute (as text)string BackFaceRefractiveIndexTextBackFaceFresnelModeEnum attributeSpeosDes.ProjectionLens.EnumBackFaceFresnelMode BackFaceFresnelModeBackFaceFresnelModeIndexEnum attribute (as index)int BackFaceFresnelModeIndexBackFaceStepNumber attributedouble BackFaceStepBackFaceStepTextNumber attribute (as text)string BackFaceStepTextBackFaceHeightNumber attributedouble BackFaceHeightBackFaceHeightTextNumber attribute (as text)string BackFaceHeightTextBackFaceDraftAngleNumber attributedouble BackFaceDraftAngleBackFaceDraftAngleTextNumber attribute (as text)string BackFaceDraftAngleTextBackFaceAsphericalsChildren attributeSpeosDes.ProjectionLens.ProjectionLensBackFaceAsphericals BackFaceAsphericalsBackFaceZernikeCoefficientsChildren attributeSpeosDes.ProjectionLens.ProjectionLensBackFaceZernikeCoefficients BackFaceZernikeCoefficientsFrontFaceApertureDiameterNumber attributedouble FrontFaceApertureDiameterFrontFaceApertureDiameterTextNumber attribute (as text)string FrontFaceApertureDiameterTextFrontRadiusCurvatureNumber attributedouble FrontRadiusCurvatureFrontRadiusCurvatureTextNumber attribute (as text)string FrontRadiusCurvatureTextFrontConicConstantNumber attributedouble FrontConicConstantFrontConicConstantTextNumber attribute (as text)string FrontConicConstantTextFrontFaceRefractiveIndexNumber attributedouble FrontFaceRefractiveIndexFrontFaceRefractiveIndexTextNumber attribute (as text)string FrontFaceRefractiveIndexTextFrontFaceFresnelModeEnum attributeSpeosDes.ProjectionLens.EnumFrontFaceFresnelMode FrontFaceFresnelModeFrontFaceFresnelModeIndexEnum attribute (as index)int FrontFaceFresnelModeIndexFrontFaceStepNumber attributedouble FrontFaceStepFrontFaceStepTextNumber attribute (as text)string FrontFaceStepTextFrontFaceHeightNumber attributedouble FrontFaceHeightFrontFaceHeightTextNumber attribute (as text)string FrontFaceHeightTextFrontFaceDraftAngleNumber attributedouble FrontFaceDraftAngleFrontFaceDraftAngleTextNumber attribute (as text)string FrontFaceDraftAngleTextFrontFaceAsphericalsChildren attributeSpeosDes.ProjectionLens.ProjectionLensFrontFaceAsphericals FrontFaceAsphericalsFrontFaceZernikeCoefficientsChildren attributeSpeosDes.ProjectionLens.ProjectionLensFrontFaceZernikeCoefficients FrontFaceZernikeCoefficientsSubjectDeprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapperSpaceClaim.Api.V242.CustomObject SubjectOccurrenceGet the underlying CustomObject occurrence, associated to the API object wrapper in current API versionobject OccurrenceNameGet or Set the name of the objectstring NameVisibleChange the visibility status (same behavior as checking/unchecking on the tree view item)bool VisibleStatusInfoGet the status of the object (warning or error message)string StatusInfoIsUpToDateAsk if the object was modified since its last successful computationbool IsUpToDate### ProjectionLens.ProjectionLensFocalPoint

### Method

NameDescriptionSyntaxSetLink attribute: Set the link to a script objectbool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)SetLink attribute: Set the link to a DocObjectbool Set(SpaceClaim.Api.V242.IDocObject selectedObject)SetLink attribute: Set the link to an object (IDocObject type from unspecified version)bool Set(object docObjectFromPreviousVersion)ClearLink attribute: Clear the linkvoid Clear()### Property

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed objectSpaceClaim.Api.V242.IDocObject LinkedObject### ProjectionLens.ProjectionLensOpticalAxis

### Method

NameDescriptionSyntaxSetLink attribute: Set the link to a script objectbool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)SetLink attribute: Set the link to a DocObjectbool Set(SpaceClaim.Api.V242.IDocObject selectedObject)SetLink attribute: Set the link to an object (IDocObject type from unspecified version)bool Set(object docObjectFromPreviousVersion)ClearLink attribute: Clear the linkvoid Clear()### Property

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed objectSpaceClaim.Api.V242.IDocObject LinkedObject### ProjectionLens.ProjectionLensZernikeOrientation

### Method

NameDescriptionSyntaxSetLink attribute: Set the link to a script objectbool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)SetLink attribute: Set the link to a DocObjectbool Set(SpaceClaim.Api.V242.IDocObject selectedObject)SetLink attribute: Set the link to an object (IDocObject type from unspecified version)bool Set(object docObjectFromPreviousVersion)ClearLink attribute: Clear the linkvoid Clear()### Property

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed objectSpaceClaim.Api.V242.IDocObject LinkedObject### ProjectionLens.ProjectionLensRevolutionOriginPoint

### Method

NameDescriptionSyntaxSetLink attribute: Set the link to a script objectbool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)SetLink attribute: Set the link to a DocObjectbool Set(SpaceClaim.Api.V242.IDocObject selectedObject)SetLink attribute: Set the link to an object (IDocObject type from unspecified version)bool Set(object docObjectFromPreviousVersion)ClearLink attribute: Clear the linkvoid Clear()### Property

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed objectSpaceClaim.Api.V242.IDocObject LinkedObject### ProjectionLens.ProjectionLensRevolutionAxis

### Method

NameDescriptionSyntaxSetLink attribute: Set the link to a script objectbool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)SetLink attribute: Set the link to a DocObjectbool Set(SpaceClaim.Api.V242.IDocObject selectedObject)SetLink attribute: Set the link to an object (IDocObject type from unspecified version)bool Set(object docObjectFromPreviousVersion)ClearLink attribute: Clear the linkvoid Clear()### Property

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed objectSpaceClaim.Api.V242.IDocObject LinkedObject### ProjectionLens.ProjectionLensExtrusionAxis

### Method

NameDescriptionSyntaxSetLink attribute: Set the link to a script objectbool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)SetLink attribute: Set the link to a DocObjectbool Set(SpaceClaim.Api.V242.IDocObject selectedObject)SetLink attribute: Set the link to an object (IDocObject type from unspecified version)bool Set(object docObjectFromPreviousVersion)ClearLink attribute: Clear the linkvoid Clear()### Property

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed objectSpaceClaim.Api.V242.IDocObject LinkedObject### ProjectionLens.ProjectionLensBackFaceAsphericals

### Method

NameDescriptionSyntaxSetChildren attribute: Set from an array of script objectsbool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject\[\] selectedObjects)SetChildren attribute: Set from an array of document objectsbool Set(SpaceClaim.Api.V242.IDocObject\[\] selectedObjects)SetChildren attribute: Set from an array of objects (IDocObject type from unspecified version)bool Set(System.Object\[\] docObjectsFromPreviousVersion)GetEnumeratorChildren attribute: Get children enumerationIEnumerator&lt;SpeosDes.Aspherics&gt; GetEnumerator()SelectAllChildren attribute: Create children for all objects that are compatible with link selection.void SelectAll()### Property

NameDescriptionSyntaxLinkedObjectsChildren attribute: Get linked objectsIReadOnlyCollection&lt;SpaceClaim.Api.V242.IDocObject&gt; LinkedObjectsCountChildren attribute: Get children countint CountListChildren attribute: Get children collectionIReadOnlyCollection&lt;SpeosDes.Aspherics&gt; ListItemChildren attribute: Get child by indexSpeosDes.Aspherics Item### ProjectionLens.ProjectionLensBackFaceZernikeCoefficients

### Method

NameDescriptionSyntaxSetChildren attribute: Set from an array of script objectsbool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject\[\] selectedObjects)SetChildren attribute: Set from an array of document objectsbool Set(SpaceClaim.Api.V242.IDocObject\[\] selectedObjects)SetChildren attribute: Set from an array of objects (IDocObject type from unspecified version)bool Set(System.Object\[\] docObjectsFromPreviousVersion)GetEnumeratorChildren attribute: Get children enumerationIEnumerator&lt;SpeosDes.ZernikeCoefficient&gt; GetEnumerator()SelectAllChildren attribute: Create children for all objects that are compatible with link selection.void SelectAll()### Property

NameDescriptionSyntaxLinkedObjectsChildren attribute: Get linked objectsIReadOnlyCollection&lt;SpaceClaim.Api.V242.IDocObject&gt; LinkedObjectsCountChildren attribute: Get children countint CountListChildren attribute: Get children collectionIReadOnlyCollection&lt;SpeosDes.ZernikeCoefficient&gt; ListItemChildren attribute: Get child by indexSpeosDes.ZernikeCoefficient Item### ProjectionLens.ProjectionLensFrontFaceAsphericals

### Method

NameDescriptionSyntaxSetChildren attribute: Set from an array of script objectsbool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject\[\] selectedObjects)SetChildren attribute: Set from an array of document objectsbool Set(SpaceClaim.Api.V242.IDocObject\[\] selectedObjects)SetChildren attribute: Set from an array of objects (IDocObject type from unspecified version)bool Set(System.Object\[\] docObjectsFromPreviousVersion)GetEnumeratorChildren attribute: Get children enumerationIEnumerator&lt;SpeosDes.Aspherics&gt; GetEnumerator()SelectAllChildren attribute: Create children for all objects that are compatible with link selection.void SelectAll()### Property

NameDescriptionSyntaxLinkedObjectsChildren attribute: Get linked objectsIReadOnlyCollection&lt;SpaceClaim.Api.V242.IDocObject&gt; LinkedObjectsCountChildren attribute: Get children countint CountListChildren attribute: Get children collectionIReadOnlyCollection&lt;SpeosDes.Aspherics&gt; ListItemChildren attribute: Get child by indexSpeosDes.Aspherics Item### ProjectionLens.ProjectionLensFrontFaceZernikeCoefficients

### Method

NameDescriptionSyntaxSetChildren attribute: Set from an array of script objectsbool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject\[\] selectedObjects)SetChildren attribute: Set from an array of document objectsbool Set(SpaceClaim.Api.V242.IDocObject\[\] selectedObjects)SetChildren attribute: Set from an array of objects (IDocObject type from unspecified version)bool Set(System.Object\[\] docObjectsFromPreviousVersion)GetEnumeratorChildren attribute: Get children enumerationIEnumerator&lt;SpeosDes.ZernikeCoefficient&gt; GetEnumerator()SelectAllChildren attribute: Create children for all objects that are compatible with link selection.void SelectAll()### Property

NameDescriptionSyntaxLinkedObjectsChildren attribute: Get linked objectsIReadOnlyCollection&lt;SpaceClaim.Api.V242.IDocObject&gt; LinkedObjectsCountChildren attribute: Get children countint CountListChildren attribute: Get children collectionIReadOnlyCollection&lt;SpeosDes.ZernikeCoefficient&gt; ListItemChildren attribute: Get child by indexSpeosDes.ZernikeCoefficient Item## RectangularLens

### Static method

NameDescriptionSyntaxFromSelectionConvert Items of a ScriptSelection to a list of Speos objects when their type is matching.IEnumerable&lt;SpeosDes.RectangularLens&gt; FromSelection(IEnumerable&lt;SpaceClaim.Api.V242.IDocObject&gt; selectionItems)FindReturns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.\*")SpeosDes.RectangularLens Find(string objectName)CreateCreate a new object of this type under the specified parent componentSpeosDes.RectangularLens Create(object parent)CreateCreate a new object in the active contextSpeosDes.RectangularLens Create()### Method

NameDescriptionSyntaxCloneCreate a copy of this object in the active contextSpeosDes.RectangularLens Clone()CopyToCreate a copy of this object and paste it to the specified destinationSpeosDes.RectangularLens CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)AddGroupCall the 'AddGroup' command.void AddGroup()FindOccurrenceInActivePartSearch for occurrences of this object in the active Partobject FindOccurrenceInActivePart()FindOccurrenceInContextOfSearch for occurrences of this object in the specified PartSpaceClaim.Api.V242.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V242.IDocObject contextObject)ToStringGet a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable)string ToString()DeleteDelete this objectbool Delete()GetChildSubjectsRetrieve all children as DocObjectsIEnumerable&lt;SpaceClaim.Api.V242.CustomObject&gt; GetChildSubjects()GetChildrenRetrieve all direct children of a given typeIEnumerable&lt;TSpecificApiType&gt; GetChildren&lt;TSpecificApiType&gt;()ComputeExecute the Compute command on the objectvoid Compute()PublishParameterPublish or un-publish a number attribute as driving parametervoid PublishParameter(string fieldName, bool trueToPublish)PublishAllParametersToWorkbenchCall this method to expose all object's attributes so that they can be accessible and driven from Workbench.void PublishAllParametersToWorkbench(bool trueToPublish)ApplyPresetUpdate the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error.void ApplyPreset(string presetFilePath)ExportToPresetExport the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error.string ExportToPreset(string filePath)### Property

NameDescriptionSyntaxStyleChild CustomObject attributeSpeosDes.OpticalFeatureStyleRectangular StyleGeneralChild CustomObject attributeSpeosDes.OpticalFeatureGeneral GeneralGroupsChildren CustomObjects attributeSpeosDes.RectangularLens.RectangularLensGroups GroupsManufacturingChild CustomObject attributeSpeosDes.OpticalFeatureManufacturing ManufacturingExcelFileFile attributeFou.Utils.ValueObjects.FilePath ExcelFileExcelFileFullPathFile attribute (absolute full path)string ExcelFileFullPathSubjectDeprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapperSpaceClaim.Api.V242.CustomObject SubjectOccurrenceGet the underlying CustomObject occurrence, associated to the API object wrapper in current API versionobject OccurrenceNameGet or Set the name of the objectstring NameVisibleChange the visibility status (same behavior as checking/unchecking on the tree view item)bool VisibleStatusInfoGet the status of the object (warning or error message)string StatusInfoIsUpToDateAsk if the object was modified since its last successful computationbool IsUpToDate### RectangularLens.RectangularLensGroups

### Method

NameDescriptionSyntaxGetEnumeratorGet children CustomObjects enumerationIEnumerator&lt;SpeosDes.OpticalGroup&gt; GetEnumerator()AddNewCreate a new child CustomObjectSpeosDes.OpticalGroup AddNew(int insertIndex)DeleteDelete a child CustomObject by indexvoid Delete(int index)### Property

NameDescriptionSyntaxCountGet children CustomObjects countint CountListGet children CustomObjects listIReadOnlyCollection&lt;SpeosDes.OpticalGroup&gt; ListItemGet child CustomObject by indexSpeosDes.OpticalGroup ItemItemGet child CustomObject by indexSpeosDes.OpticalGroup Item## RectangularSurface

### Static method

NameDescriptionSyntaxFromSelectionConvert Items of a ScriptSelection to a list of Speos objects when their type is matching.IEnumerable&lt;SpeosDes.RectangularSurface&gt; FromSelection(IEnumerable&lt;SpaceClaim.Api.V242.IDocObject&gt; selectionItems)FindReturns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.\*")SpeosDes.RectangularSurface Find(string objectName)CreateCreate a new object of this type under the specified parent componentSpeosDes.RectangularSurface Create(object parent)CreateCreate a new object in the active contextSpeosDes.RectangularSurface Create()### Method

NameDescriptionSyntaxCloneCreate a copy of this object in the active contextSpeosDes.RectangularSurface Clone()CopyToCreate a copy of this object and paste it to the specified destinationSpeosDes.RectangularSurface CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)AddGroupCall the 'AddGroup' command.void AddGroup()FindOccurrenceInActivePartSearch for occurrences of this object in the active Partobject FindOccurrenceInActivePart()FindOccurrenceInContextOfSearch for occurrences of this object in the specified PartSpaceClaim.Api.V242.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V242.IDocObject contextObject)ToStringGet a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable)string ToString()DeleteDelete this objectbool Delete()GetChildSubjectsRetrieve all children as DocObjectsIEnumerable&lt;SpaceClaim.Api.V242.CustomObject&gt; GetChildSubjects()GetChildrenRetrieve all direct children of a given typeIEnumerable&lt;TSpecificApiType&gt; GetChildren&lt;TSpecificApiType&gt;()ComputeExecute the Compute command on the objectvoid Compute()PublishParameterPublish or un-publish a number attribute as driving parametervoid PublishParameter(string fieldName, bool trueToPublish)PublishAllParametersToWorkbenchCall this method to expose all object's attributes so that they can be accessible and driven from Workbench.void PublishAllParametersToWorkbench(bool trueToPublish)ApplyPresetUpdate the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error.void ApplyPreset(string presetFilePath)ExportToPresetExport the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error.string ExportToPreset(string filePath)### Property

NameDescriptionSyntaxStyleChild CustomObject attributeSpeosDes.OpticalFeatureStyleRectangular StyleGeneralChild CustomObject attributeSpeosDes.OpticalFeatureGeneral GeneralGroupsChildren CustomObjects attributeSpeosDes.RectangularSurface.RectangularSurfaceGroups GroupsManufacturingChild CustomObject attributeSpeosDes.OpticalFeatureManufacturing ManufacturingExcelFileFile attributeFou.Utils.ValueObjects.FilePath ExcelFileExcelFileFullPathFile attribute (absolute full path)string ExcelFileFullPathSubjectDeprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapperSpaceClaim.Api.V242.CustomObject SubjectOccurrenceGet the underlying CustomObject occurrence, associated to the API object wrapper in current API versionobject OccurrenceNameGet or Set the name of the objectstring NameVisibleChange the visibility status (same behavior as checking/unchecking on the tree view item)bool VisibleStatusInfoGet the status of the object (warning or error message)string StatusInfoIsUpToDateAsk if the object was modified since its last successful computationbool IsUpToDate### RectangularSurface.RectangularSurfaceGroups

### Method

NameDescriptionSyntaxGetEnumeratorGet children CustomObjects enumerationIEnumerator&lt;SpeosDes.OpticalGroup&gt; GetEnumerator()AddNewCreate a new child CustomObjectSpeosDes.OpticalGroup AddNew(int insertIndex)DeleteDelete a child CustomObject by indexvoid Delete(int index)### Property

NameDescriptionSyntaxCountGet children CustomObjects countint CountListGet children CustomObjects listIReadOnlyCollection&lt;SpeosDes.OpticalGroup&gt; ListItemGet child CustomObject by indexSpeosDes.OpticalGroup ItemItemGet child CustomObject by indexSpeosDes.OpticalGroup Item## ResultHOD

### Static method

NameDescriptionSyntaxFromSelectionConvert Items of a ScriptSelection to a list of Speos objects when their type is matching.IEnumerable&lt;SpeosDes.ResultHOD&gt; FromSelection(IEnumerable&lt;SpaceClaim.Api.V242.IDocObject&gt; selectionItems)FindReturns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.\*")SpeosDes.ResultHOD Find(string objectName)### Method

NameDescriptionSyntaxFindOccurrenceInActivePartSearch for occurrences of this object in the active Partobject FindOccurrenceInActivePart()FindOccurrenceInContextOfSearch for occurrences of this object in the specified PartSpaceClaim.Api.V242.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V242.IDocObject contextObject)ToStringGet a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable)string ToString()DeleteDelete this objectbool Delete()GetChildSubjectsRetrieve all children as DocObjectsIEnumerable&lt;SpaceClaim.Api.V242.CustomObject&gt; GetChildSubjects()GetChildrenRetrieve all direct children of a given typeIEnumerable&lt;TSpecificApiType&gt; GetChildren&lt;TSpecificApiType&gt;()ComputeExecute the Compute command on the objectvoid Compute()PublishParameterPublish or un-publish a number attribute as driving parametervoid PublishParameter(string fieldName, bool trueToPublish)PublishAllParametersToWorkbenchCall this method to expose all object's attributes so that they can be accessible and driven from Workbench.void PublishAllParametersToWorkbench(bool trueToPublish)ApplyPresetUpdate the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error.void ApplyPreset(string presetFilePath)ExportToPresetExport the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error.string ExportToPreset(string filePath)### Property

NameDescriptionSyntaxResultTypeEnum attributeSpeosDes.ResultHOD.EnumResultType ResultTypeResultTypeIndexEnum attribute (as index)int ResultTypeIndexFullPathGet the result file full pathstring FullPathSubjectDeprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapperSpaceClaim.Api.V242.CustomObject SubjectOccurrenceGet the underlying CustomObject occurrence, associated to the API object wrapper in current API versionobject OccurrenceNameGet or Set the name of the objectstring NameVisibleChange the visibility status (same behavior as checking/unchecking on the tree view item)bool VisibleStatusInfoGet the status of the object (warning or error message)string StatusInfoIsUpToDateAsk if the object was modified since its last successful computationbool IsUpToDate## StripesLens

### Static method

NameDescriptionSyntaxFromSelectionConvert Items of a ScriptSelection to a list of Speos objects when their type is matching.IEnumerable&lt;SpeosDes.StripesLens&gt; FromSelection(IEnumerable&lt;SpaceClaim.Api.V242.IDocObject&gt; selectionItems)FindReturns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.\*")SpeosDes.StripesLens Find(string objectName)CreateCreate a new object of this type under the specified parent componentSpeosDes.StripesLens Create(object parent)CreateCreate a new object in the active contextSpeosDes.StripesLens Create()### Method

NameDescriptionSyntaxCloneCreate a copy of this object in the active contextSpeosDes.StripesLens Clone()CopyToCreate a copy of this object and paste it to the specified destinationSpeosDes.StripesLens CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)AddGroupCall the 'AddGroup' command.void AddGroup()FindOccurrenceInActivePartSearch for occurrences of this object in the active Partobject FindOccurrenceInActivePart()FindOccurrenceInContextOfSearch for occurrences of this object in the specified PartSpaceClaim.Api.V242.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V242.IDocObject contextObject)ToStringGet a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable)string ToString()DeleteDelete this objectbool Delete()GetChildSubjectsRetrieve all children as DocObjectsIEnumerable&lt;SpaceClaim.Api.V242.CustomObject&gt; GetChildSubjects()GetChildrenRetrieve all direct children of a given typeIEnumerable&lt;TSpecificApiType&gt; GetChildren&lt;TSpecificApiType&gt;()ComputeExecute the Compute command on the objectvoid Compute()PublishParameterPublish or un-publish a number attribute as driving parametervoid PublishParameter(string fieldName, bool trueToPublish)PublishAllParametersToWorkbenchCall this method to expose all object's attributes so that they can be accessible and driven from Workbench.void PublishAllParametersToWorkbench(bool trueToPublish)ApplyPresetUpdate the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error.void ApplyPreset(string presetFilePath)ExportToPresetExport the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error.string ExportToPreset(string filePath)### Property

NameDescriptionSyntaxStyleChild CustomObject attributeSpeosDes.OpticalFeatureStyleStripes StyleGeneralChild CustomObject attributeSpeosDes.OpticalFeatureGeneral GeneralGroupsChildren CustomObjects attributeSpeosDes.StripesLens.StripesLensGroups GroupsManufacturingChild CustomObject attributeSpeosDes.OpticalFeatureManufacturing ManufacturingExcelFileFile attributeFou.Utils.ValueObjects.FilePath ExcelFileExcelFileFullPathFile attribute (absolute full path)string ExcelFileFullPathSubjectDeprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapperSpaceClaim.Api.V242.CustomObject SubjectOccurrenceGet the underlying CustomObject occurrence, associated to the API object wrapper in current API versionobject OccurrenceNameGet or Set the name of the objectstring NameVisibleChange the visibility status (same behavior as checking/unchecking on the tree view item)bool VisibleStatusInfoGet the status of the object (warning or error message)string StatusInfoIsUpToDateAsk if the object was modified since its last successful computationbool IsUpToDate### StripesLens.StripesLensGroups

### Method

NameDescriptionSyntaxGetEnumeratorGet children CustomObjects enumerationIEnumerator&lt;SpeosDes.OpticalGroup&gt; GetEnumerator()AddNewCreate a new child CustomObjectSpeosDes.OpticalGroup AddNew(int insertIndex)DeleteDelete a child CustomObject by indexvoid Delete(int index)### Property

NameDescriptionSyntaxCountGet children CustomObjects countint CountListGet children CustomObjects listIReadOnlyCollection&lt;SpeosDes.OpticalGroup&gt; ListItemGet child CustomObject by indexSpeosDes.OpticalGroup ItemItemGet child CustomObject by indexSpeosDes.OpticalGroup Item## StripesSurface

### Static method

NameDescriptionSyntaxFromSelectionConvert Items of a ScriptSelection to a list of Speos objects when their type is matching.IEnumerable&lt;SpeosDes.StripesSurface&gt; FromSelection(IEnumerable&lt;SpaceClaim.Api.V242.IDocObject&gt; selectionItems)FindReturns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.\*")SpeosDes.StripesSurface Find(string objectName)CreateCreate a new object of this type under the specified parent componentSpeosDes.StripesSurface Create(object parent)CreateCreate a new object in the active contextSpeosDes.StripesSurface Create()### Method

NameDescriptionSyntaxCloneCreate a copy of this object in the active contextSpeosDes.StripesSurface Clone()CopyToCreate a copy of this object and paste it to the specified destinationSpeosDes.StripesSurface CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)AddGroupCall the 'AddGroup' command.void AddGroup()FindOccurrenceInActivePartSearch for occurrences of this object in the active Partobject FindOccurrenceInActivePart()FindOccurrenceInContextOfSearch for occurrences of this object in the specified PartSpaceClaim.Api.V242.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V242.IDocObject contextObject)ToStringGet a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable)string ToString()DeleteDelete this objectbool Delete()GetChildSubjectsRetrieve all children as DocObjectsIEnumerable&lt;SpaceClaim.Api.V242.CustomObject&gt; GetChildSubjects()GetChildrenRetrieve all direct children of a given typeIEnumerable&lt;TSpecificApiType&gt; GetChildren&lt;TSpecificApiType&gt;()ComputeExecute the Compute command on the objectvoid Compute()PublishParameterPublish or un-publish a number attribute as driving parametervoid PublishParameter(string fieldName, bool trueToPublish)PublishAllParametersToWorkbenchCall this method to expose all object's attributes so that they can be accessible and driven from Workbench.void PublishAllParametersToWorkbench(bool trueToPublish)ApplyPresetUpdate the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error.void ApplyPreset(string presetFilePath)ExportToPresetExport the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error.string ExportToPreset(string filePath)### Property

NameDescriptionSyntaxStyleChild CustomObject attributeSpeosDes.OpticalFeatureStyleStripes StyleGeneralChild CustomObject attributeSpeosDes.OpticalFeatureGeneral GeneralGroupsChildren CustomObjects attributeSpeosDes.StripesSurface.StripesSurfaceGroups GroupsManufacturingChild CustomObject attributeSpeosDes.OpticalFeatureManufacturing ManufacturingExcelFileFile attributeFou.Utils.ValueObjects.FilePath ExcelFileExcelFileFullPathFile attribute (absolute full path)string ExcelFileFullPathSubjectDeprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapperSpaceClaim.Api.V242.CustomObject SubjectOccurrenceGet the underlying CustomObject occurrence, associated to the API object wrapper in current API versionobject OccurrenceNameGet or Set the name of the objectstring NameVisibleChange the visibility status (same behavior as checking/unchecking on the tree view item)bool VisibleStatusInfoGet the status of the object (warning or error message)string StatusInfoIsUpToDateAsk if the object was modified since its last successful computationbool IsUpToDate### StripesSurface.StripesSurfaceGroups

### Method

NameDescriptionSyntaxGetEnumeratorGet children CustomObjects enumerationIEnumerator&lt;SpeosDes.OpticalGroup&gt; GetEnumerator()AddNewCreate a new child CustomObjectSpeosDes.OpticalGroup AddNew(int insertIndex)DeleteDelete a child CustomObject by indexvoid Delete(int index)### Property

NameDescriptionSyntaxCountGet children CustomObjects countint CountListGet children CustomObjects listIReadOnlyCollection&lt;SpeosDes.OpticalGroup&gt; ListItemGet child CustomObject by indexSpeosDes.OpticalGroup ItemItemGet child CustomObject by indexSpeosDes.OpticalGroup Item## TIRLens

### Static method

NameDescriptionSyntaxFromSelectionConvert Items of a ScriptSelection to a list of Speos objects when their type is matching.IEnumerable&lt;SpeosDes.TIRLens&gt; FromSelection(IEnumerable&lt;SpaceClaim.Api.V242.IDocObject&gt; selectionItems)FindReturns the object whose name matches exactly the specified string. Or, if the exact name is not found, the first object whose name matches the string as a regular expression. Example: Find("StartOfName.\*")SpeosDes.TIRLens Find(string objectName)CreateCreate a new object of this type under the specified parent componentSpeosDes.TIRLens Create(object parent)CreateCreate a new object in the active contextSpeosDes.TIRLens Create()### Method

NameDescriptionSyntaxCloneCreate a copy of this object in the active contextSpeosDes.TIRLens Clone()CopyToCreate a copy of this object and paste it to the specified destinationSpeosDes.TIRLens CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)FindOccurrenceInActivePartSearch for occurrences of this object in the active Partobject FindOccurrenceInActivePart()FindOccurrenceInContextOfSearch for occurrences of this object in the specified PartSpaceClaim.Api.V242.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.V242.IDocObject contextObject)ToStringGet a text representation of the object (used by the Script interpreter when the mouse cursor hovers an object variable)string ToString()DeleteDelete this objectbool Delete()GetChildSubjectsRetrieve all children as DocObjectsIEnumerable&lt;SpaceClaim.Api.V242.CustomObject&gt; GetChildSubjects()GetChildrenRetrieve all direct children of a given typeIEnumerable&lt;TSpecificApiType&gt; GetChildren&lt;TSpecificApiType&gt;()ComputeExecute the Compute command on the objectvoid Compute()PublishParameterPublish or un-publish a number attribute as driving parametervoid PublishParameter(string fieldName, bool trueToPublish)PublishAllParametersToWorkbenchCall this method to expose all object's attributes so that they can be accessible and driven from Workbench.void PublishAllParametersToWorkbench(bool trueToPublish)ApplyPresetUpdate the object configuration values according to the specified Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error.void ApplyPreset(string presetFilePath)ExportToPresetExport the current object configuration to a Preset file. Note: some object types are not compatible with the 'Presets' feature, and in such a case the method will report an error.string ExportToPreset(string filePath)### Property

NameDescriptionSyntaxBuildTypeEnum attributeSpeosDes.TIRLens.EnumBuildType BuildTypeBuildTypeIndexEnum attribute (as index)int BuildTypeIndexSourceLink attributeSpeosDes.TIRLens.TIRLensSource SourceSupportPlaneLink attributeSpeosDes.TIRLens.TIRLensSupportPlane SupportPlaneInputRadiusNumber attributedouble InputRadiusInputRadiusTextNumber attribute (as text)string InputRadiusTextDepthNumber attributedouble DepthDepthTextNumber attribute (as text)string DepthTextDraftAngleNumber attributedouble DraftAngleDraftAngleTextNumber attribute (as text)string DraftAngleTextSupportThicknessNumber attributedouble SupportThicknessSupportThicknessTextNumber attribute (as text)string SupportThicknessTextRefractiveIndexNumber attributedouble RefractiveIndexRefractiveIndexTextNumber attribute (as text)string RefractiveIndexTextThicknessNumber attributedouble ThicknessThicknessTextNumber attribute (as text)string ThicknessTextThicknessOutNumber attributedouble ThicknessOutThicknessOutTextNumber attribute (as text)string ThicknessOutTextOutputRadiusNumber attributedouble OutputRadiusOutputRadiusTextNumber attribute (as text)string OutputRadiusTextOutputRadiusOutNumber attributedouble OutputRadiusOutOutputRadiusOutTextNumber attribute (as text)string OutputRadiusOutTextFocalNumber attributedouble FocalFocalTextNumber attribute (as text)string FocalTextReverseDirectionBoolean attributebool ReverseDirectionSpreadNumber attributedouble SpreadSpreadTextNumber attribute (as text)string SpreadTextSpreadBehaviorEnum attributeSpeosDes.TIRLens.EnumSpreadBehavior SpreadBehaviorSpreadBehaviorIndexEnum attribute (as index)int SpreadBehaviorIndexSpreadControlNumber attributedouble SpreadControlSpreadControlTextNumber attribute (as text)string SpreadControlTextSubjectDeprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapperSpaceClaim.Api.V242.CustomObject SubjectOccurrenceGet the underlying CustomObject occurrence, associated to the API object wrapper in current API versionobject OccurrenceNameGet or Set the name of the objectstring NameVisibleChange the visibility status (same behavior as checking/unchecking on the tree view item)bool VisibleStatusInfoGet the status of the object (warning or error message)string StatusInfoIsUpToDateAsk if the object was modified since its last successful computationbool IsUpToDate### TIRLens.TIRLensSource

### Method

NameDescriptionSyntaxSetLink attribute: Set the link to a script objectbool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)SetLink attribute: Set the link to a DocObjectbool Set(SpaceClaim.Api.V242.IDocObject selectedObject)SetLink attribute: Set the link to an object (IDocObject type from unspecified version)bool Set(object docObjectFromPreviousVersion)ClearLink attribute: Clear the linkvoid Clear()### Property

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed objectSpaceClaim.Api.V242.IDocObject LinkedObject### TIRLens.TIRLensSupportPlane

### Method

NameDescriptionSyntaxSetLink attribute: Set the link to a script objectbool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject selectedObject)SetLink attribute: Set the link to a DocObjectbool Set(SpaceClaim.Api.V242.IDocObject selectedObject)SetLink attribute: Set the link to an object (IDocObject type from unspecified version)bool Set(object docObjectFromPreviousVersion)ClearLink attribute: Clear the linkvoid Clear()### Property

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed objectSpaceClaim.Api.V242.IDocObject LinkedObject## ZernikeCoefficient

### Static method

NameDescriptionSyntaxCreateCreate a new object of this typeSpeosDes.ZernikeCoefficient Create()### Method

NameDescriptionSyntaxToStringstring ToString()### Property

NameDescriptionSyntaxIndexNumber attributeint IndexIndexTextNumber attribute (as text)string IndexTextValueNumber attributedouble ValueValueTextNumber attribute (as text)string ValueText