    

 ## On this page

  

 

 # SpeosDes

 Last update: 29.07.2026 

## Command

### Static method

NameDescriptionSyntaxGetErrorStatusGet the error status of the given object`string GetErrorStatus(object docObject)`IsUpToDateAsk if the given object was modified since its last successful computation`bool IsUpToDate(object docObject)`SetActiveSelectionSet the active selection from a collection of DocObjects`void SetActiveSelection(ICollection<object> selectedObjects)`GetSpeosObjectsInActivePartGet the Speos objects contained in the active Part`IEnumerable<object> GetSpeosObjectsInActivePart()`Compute`void Compute(System.Object[] selectedObjects)`ComputePerform the computation of an array of DocObjects`void Compute(SpaceClaim.Api.v261.IDocObject[] selectedObjects)`ComputePerform the computation of an array of script objects`void Compute(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)`ComputeOnActiveSelectionPerform the computation of the active selection`void ComputeOnActiveSelection()`## Aspherics

### Static method

NameDescriptionSyntaxCreateCreate a new object of this type`SpeosDes.Aspherics Create()`### Method

NameDescriptionSyntaxToString`string ToString()`### Property

NameDescriptionSyntaxIndexNumber attribute`int Index`IndexTextNumber attribute (as text)`string IndexText`ValueNumber attribute`double Value`ValueTextNumber 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<SpeosDes.CircularLens> FromSelection(IEnumerable<SpaceClaim.Api.v261.IDocObject> 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 component`SpeosDes.CircularLens Create(object parent)`CreateCreate a new object in the active context`SpeosDes.CircularLens Create()`### Method

NameDescriptionSyntaxCloneCreate a copy of this object in the active context`SpeosDes.CircularLens Clone()`CopyToCreate a copy of this object and paste it to the specified destination`SpeosDes.CircularLens CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)`AddGroupCall the 'AddGroup' command.`void AddGroup()`FindOccurrenceInActivePartSearch for occurrences of this object in the active Part`object FindOccurrenceInActivePart()`FindOccurrenceInContextOfSearch for occurrences of this object in the specified Part`SpaceClaim.Api.v261.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.v261.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 object`bool Delete()`GetChildSubjectsRetrieve all children as DocObjects`IEnumerable<SpaceClaim.Api.v261.CustomObject> GetChildSubjects()`GetChildrenRetrieve all direct children of a given type`IEnumerable<TSpecificApiType> GetChildren<TSpecificApiType>()`ComputeExecute the Compute command on the object`void Compute()`PublishParameterPublish or un-publish a number attribute as driving parameter`void 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 attribute`SpeosDes.OpticalFeatureStyleCircular Style`GeneralChild CustomObject attribute`SpeosDes.OpticalFeatureGeneral General`GroupsChildren CustomObjects attribute`SpeosDes.CircularLens.CircularLensGroups Groups`TirLensChildren CustomObjects attribute`SpeosDes.CircularLens.CircularLensTirLens TirLens`ManufacturingChild CustomObject attribute`SpeosDes.OpticalFeatureManufacturing Manufacturing`ExcelFileFile attribute`Speos.Foundation.Utils.File.FilePath ExcelFile`ExcelFileFullPathFile attribute (absolute full path)`string ExcelFileFullPath`SubjectDeprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper`SpaceClaim.Api.v261.CustomObject Subject`OccurrenceGet the underlying CustomObject occurrence, associated to the API object wrapper in current API version`object Occurrence`NameGet or Set the name of the object`string Name`VisibleChange the visibility status (same behavior as checking/unchecking on the tree view item)`bool Visible`StatusInfoGet the status of the object (warning or error message)`string StatusInfo`IsUpToDateAsk if the object was modified since its last successful computation`bool IsUpToDate`## CircularLens.CircularLensGroups

### Method

NameDescriptionSyntaxGetEnumeratorGet children CustomObjects enumeration`IEnumerator<SpeosDes.OpticalGroup> GetEnumerator()`AddNewCreate a new child CustomObject`SpeosDes.OpticalGroup AddNew(int insertIndex)`DeleteDelete a child CustomObject by index`void Delete(int index)`### Property

NameDescriptionSyntaxCountGet children CustomObjects count`int Count`ListGet children CustomObjects list`IReadOnlyCollection<SpeosDes.OpticalGroup> List`ItemGet child CustomObject by index`SpeosDes.OpticalGroup Item`ItemGet child CustomObject by index`SpeosDes.OpticalGroup Item`## CircularLens.CircularLensTirLens

### Method

NameDescriptionSyntaxGetEnumeratorGet children CustomObjects enumeration`IEnumerator<SpeosDes.TIRLens> GetEnumerator()`AddNewCreate a new child CustomObject`SpeosDes.TIRLens AddNew(int insertIndex)`DeleteDelete a child CustomObject by index`void Delete(int index)`### Property

NameDescriptionSyntaxCountGet children CustomObjects count`int Count`ListGet children CustomObjects list`IReadOnlyCollection<SpeosDes.TIRLens> List`ItemGet child CustomObject by index`SpeosDes.TIRLens Item`ItemGet child CustomObject by index`SpeosDes.TIRLens Item`## CircularSurface

### Static method

NameDescriptionSyntaxFromSelectionConvert Items of a ScriptSelection to a list of Speos objects when their type is matching.`IEnumerable<SpeosDes.CircularSurface> FromSelection(IEnumerable<SpaceClaim.Api.v261.IDocObject> 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 component`SpeosDes.CircularSurface Create(object parent)`CreateCreate a new object in the active context`SpeosDes.CircularSurface Create()`### Method

NameDescriptionSyntaxCloneCreate a copy of this object in the active context`SpeosDes.CircularSurface Clone()`CopyToCreate a copy of this object and paste it to the specified destination`SpeosDes.CircularSurface CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)`AddGroupCall the 'AddGroup' command.`void AddGroup()`FindOccurrenceInActivePartSearch for occurrences of this object in the active Part`object FindOccurrenceInActivePart()`FindOccurrenceInContextOfSearch for occurrences of this object in the specified Part`SpaceClaim.Api.v261.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.v261.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 object`bool Delete()`GetChildSubjectsRetrieve all children as DocObjects`IEnumerable<SpaceClaim.Api.v261.CustomObject> GetChildSubjects()`GetChildrenRetrieve all direct children of a given type`IEnumerable<TSpecificApiType> GetChildren<TSpecificApiType>()`ComputeExecute the Compute command on the object`void Compute()`PublishParameterPublish or un-publish a number attribute as driving parameter`void 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 attribute`SpeosDes.OpticalFeatureStyleCircular Style`GeneralChild CustomObject attribute`SpeosDes.OpticalFeatureGeneral General`GroupsChildren CustomObjects attribute`SpeosDes.CircularSurface.CircularSurfaceGroups Groups`TirLensChildren CustomObjects attribute`SpeosDes.CircularSurface.CircularSurfaceTirLens TirLens`ManufacturingChild CustomObject attribute`SpeosDes.OpticalFeatureManufacturing Manufacturing`ExcelFileFile attribute`Speos.Foundation.Utils.File.FilePath ExcelFile`ExcelFileFullPathFile attribute (absolute full path)`string ExcelFileFullPath`SubjectDeprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper`SpaceClaim.Api.v261.CustomObject Subject`OccurrenceGet the underlying CustomObject occurrence, associated to the API object wrapper in current API version`object Occurrence`NameGet or Set the name of the object`string Name`VisibleChange the visibility status (same behavior as checking/unchecking on the tree view item)`bool Visible`StatusInfoGet the status of the object (warning or error message)`string StatusInfo`IsUpToDateAsk if the object was modified since its last successful computation`bool IsUpToDate`## CircularSurface.CircularSurfaceGroups

### Method

NameDescriptionSyntaxGetEnumeratorGet children CustomObjects enumeration`IEnumerator<SpeosDes.OpticalGroup> GetEnumerator()`AddNewCreate a new child CustomObject`SpeosDes.OpticalGroup AddNew(int insertIndex)`DeleteDelete a child CustomObject by index`void Delete(int index)`### Property

NameDescriptionSyntaxCountGet children CustomObjects count`int Count`ListGet children CustomObjects list`IReadOnlyCollection<SpeosDes.OpticalGroup> List`ItemGet child CustomObject by index`SpeosDes.OpticalGroup Item`ItemGet child CustomObject by index`SpeosDes.OpticalGroup Item`## CircularSurface.CircularSurfaceTirLens

### Method

NameDescriptionSyntaxGetEnumeratorGet children CustomObjects enumeration`IEnumerator<SpeosDes.TIRLens> GetEnumerator()`AddNewCreate a new child CustomObject`SpeosDes.TIRLens AddNew(int insertIndex)`DeleteDelete a child CustomObject by index`void Delete(int index)`### Property

NameDescriptionSyntaxCountGet children CustomObjects count`int Count`ListGet children CustomObjects list`IReadOnlyCollection<SpeosDes.TIRLens> List`ItemGet child CustomObject by index`SpeosDes.TIRLens Item`ItemGet child CustomObject by index`SpeosDes.TIRLens Item`## ControlPlane

### Static method

NameDescriptionSyntaxCreateCreate a new object of this type`SpeosDes.ControlPlane Create()`### Method

NameDescriptionSyntaxToString`string ToString()`### Property

NameDescriptionSyntaxPositionNumber attribute`double Position`PositionTextNumber attribute (as text)`string PositionText`DefocusNumber attribute`double Defocus`DefocusTextNumber attribute (as text)`string DefocusText`HorizontalSpreadNumber attribute`double HorizontalSpread`HorizontalSpreadTextNumber attribute (as text)`string HorizontalSpreadText`VerticalOrientationNumber attribute`double VerticalOrientation`VerticalOrientationTextNumber attribute (as text)`string VerticalOrientationText`VerticalSpreadNumber attribute`double VerticalSpread`VerticalSpreadTextNumber attribute (as text)`string VerticalSpreadText`TiltNumber attribute`double Tilt`TiltTextNumber attribute (as text)`string TiltText`## ControlPointConfiguration

### Static method

NameDescriptionSyntaxCreateCreate a new object of this type`SpeosDes.ControlPointConfiguration Create()`### Method

NameDescriptionSyntaxToString`string ToString()`### Property

NameDescriptionSyntaxPositionNumber attribute`double Position`PositionTextNumber attribute (as text)`string PositionText`ValueNumber attribute`double Value`ValueTextNumber attribute (as text)`string ValueText`## EyeboxConfiguration

### Static method

NameDescriptionSyntaxCreateCreate a new object of this type`SpeosDes.EyeboxConfiguration Create()`### Method

NameDescriptionSyntaxToString`string ToString()`### Property

NameDescriptionSyntaxEBConfigNameString attribute`string EBConfigName`OffsetNumber attribute`double Offset`OffsetTextNumber attribute (as text)`string OffsetText`WeightNumber attribute`double Weight`WeightTextNumber 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<SpeosDes.FreeformLens> FromSelection(IEnumerable<SpaceClaim.Api.v261.IDocObject> 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 component`SpeosDes.FreeformLens Create(object parent)`CreateCreate a new object in the active context`SpeosDes.FreeformLens Create()`### Method

NameDescriptionSyntaxCloneCreate a copy of this object in the active context`SpeosDes.FreeformLens Clone()`CopyToCreate a copy of this object and paste it to the specified destination`SpeosDes.FreeformLens CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)`GetSourceTypePossibleValuesString list attribute: List possible values`IEnumerable<string> GetSourceTypePossibleValues()`GetUserInputFaceSidePossibleValuesString list attribute: List possible values`IEnumerable<string> GetUserInputFaceSidePossibleValues()`FindOccurrenceInActivePartSearch for occurrences of this object in the active Part`object FindOccurrenceInActivePart()`FindOccurrenceInContextOfSearch for occurrences of this object in the specified Part`SpaceClaim.Api.v261.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.v261.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 object`bool Delete()`GetChildSubjectsRetrieve all children as DocObjects`IEnumerable<SpaceClaim.Api.v261.CustomObject> GetChildSubjects()`GetChildrenRetrieve all direct children of a given type`IEnumerable<TSpecificApiType> GetChildren<TSpecificApiType>()`ComputeExecute the Compute command on the object`void Compute()`PublishParameterPublish or un-publish a number attribute as driving parameter`void 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 attribute`SpeosDes.FreeformLens.EnumConstructionType ConstructionType`ConstructionTypeIndexEnum attribute (as index)`int ConstructionTypeIndex`SourceTypeString list selection attribute`string SourceType`FocalPointLink attribute`SpeosDes.FreeformLens.FreeformLensFocalPoint FocalPoint`OpticalAxisLink attribute`SpeosDes.FreeformLens.FreeformLensOpticalAxis OpticalAxis`ReverseDirectionBoolean attribute`bool ReverseDirection`RefractiveIndexNumber attribute`double RefractiveIndex`RefractiveIndexTextNumber attribute (as text)`string RefractiveIndexText`UserInputFaceSideString list selection attribute`string UserInputFaceSide`FrontFaceLink attribute`SpeosDes.FreeformLens.FreeformLensFrontFace FrontFace`ThicknessNumber attribute`double Thickness`ThicknessTextNumber attribute (as text)`string ThicknessText`TargetDefinitionTypeEnum attribute`SpeosDes.FreeformLens.EnumTargetDefinitionType TargetDefinitionType`TargetDefinitionTypeIndexEnum attribute (as index)`int TargetDefinitionTypeIndex`TargetOriginLink attribute`SpeosDes.FreeformLens.FreeformLensTargetOrigin TargetOrigin`TargetXAxisLink attribute`SpeosDes.FreeformLens.FreeformLensTargetXAxis TargetXAxis`TargetYAxisLink attribute`SpeosDes.FreeformLens.FreeformLensTargetYAxis TargetYAxis`IntensityOpticalAxisLink attribute`SpeosDes.FreeformLens.FreeformLensIntensityOpticalAxis IntensityOpticalAxis`ReverseIntensityOpticalAxisDirectionBoolean attribute`bool ReverseIntensityOpticalAxisDirection`IntensityOrientationAxisLink attribute`SpeosDes.FreeformLens.FreeformLensIntensityOrientationAxis IntensityOrientationAxis`ReverseIntensityOrientationAxisDirectionBoolean attribute`bool ReverseIntensityOrientationAxisDirection`TargetTypeEnum attribute`SpeosDes.FreeformLens.EnumTargetType TargetType`TargetTypeIndexEnum attribute (as index)`int TargetTypeIndex`XTargetMaxNumber attribute`double XTargetMax`XTargetMaxTextNumber attribute (as text)`string XTargetMaxText`YTargetMaxNumber attribute`double YTargetMax`YTargetMaxTextNumber attribute (as text)`string YTargetMaxText`XTargetGaussianNumber attribute`double XTargetGaussian`XTargetGaussianTextNumber attribute (as text)`string XTargetGaussianText`YTargetGaussianNumber attribute`double YTargetGaussian`YTargetGaussianTextNumber attribute (as text)`string YTargetGaussianText`ImageFilePathFile attribute`string ImageFilePath`ImageFilePathFullPathFile attribute (absolute full path)`string ImageFilePathFullPath`TargetTypeIntensityEnum attribute`SpeosDes.FreeformLens.EnumTargetTypeIntensity TargetTypeIntensity`TargetTypeIntensityIndexEnum attribute (as index)`int TargetTypeIntensityIndex`IntensityXHalfSpreadNumber attribute`double IntensityXHalfSpread`IntensityXHalfSpreadTextNumber attribute (as text)`string IntensityXHalfSpreadText`IntensityYHalfSpreadNumber attribute`double IntensityYHalfSpread`IntensityYHalfSpreadTextNumber attribute (as text)`string IntensityYHalfSpreadText`IntensityXFWHMGaussianNumber attribute`double IntensityXFWHMGaussian`IntensityXFWHMGaussianTextNumber attribute (as text)`string IntensityXFWHMGaussianText`IntensityYFWHMGaussianNumber attribute`double IntensityYFWHMGaussian`IntensityYFWHMGaussianTextNumber attribute (as text)`string IntensityYFWHMGaussianText`IntensityFilePathFile attribute`string IntensityFilePath`IntensityFilePathFullPathFile attribute (absolute full path)`string IntensityFilePathFullPath`ImageContrastNumber attribute`int ImageContrast`ImageContrastTextNumber attribute (as text)`string ImageContrastText`ResolutionFactorNumber attribute`int ResolutionFactor`ResolutionFactorTextNumber attribute (as text)`string ResolutionFactorText`ThresholdNumber attribute`int Threshold`ThresholdTextNumber attribute (as text)`string ThresholdText`SourceBodyLink attribute`SpeosDes.FreeformLens.FreeformLensSourceBody SourceBody`FaceSizeXMinNumber attribute`double FaceSizeXMin`FaceSizeXMinTextNumber attribute (as text)`string FaceSizeXMinText`FaceSizeYMinNumber attribute`double FaceSizeYMin`FaceSizeYMinTextNumber attribute (as text)`string FaceSizeYMinText`FaceSizeXMaxNumber attribute`double FaceSizeXMax`FaceSizeXMaxTextNumber attribute (as text)`string FaceSizeXMaxText`FaceSizeYMaxNumber attribute`double FaceSizeYMax`FaceSizeYMaxTextNumber attribute (as text)`string FaceSizeYMaxText`BackFocalLengthNumber attribute`double BackFocalLength`BackFocalLengthTextNumber attribute (as text)`string BackFocalLengthText`ThicknessCenterNumber attribute`double ThicknessCenter`ThicknessCenterTextNumber attribute (as text)`string ThicknessCenterText`BeamSizeXMinNumber attribute`double BeamSizeXMin`BeamSizeXMinTextNumber attribute (as text)`string BeamSizeXMinText`BeamSizeYMinNumber attribute`double BeamSizeYMin`BeamSizeYMinTextNumber attribute (as text)`string BeamSizeYMinText`BeamSizeXMaxNumber attribute`double BeamSizeXMax`BeamSizeXMaxTextNumber attribute (as text)`string BeamSizeXMaxText`BeamSizeYMaxNumber attribute`double BeamSizeYMax`BeamSizeYMaxTextNumber attribute (as text)`string BeamSizeYMaxText`BeamMaxTargetXNumber attribute`double BeamMaxTargetX`BeamMaxTargetXTextNumber attribute (as text)`string BeamMaxTargetXText`BeamMaxTargetYNumber attribute`double BeamMaxTargetY`BeamMaxTargetYTextNumber attribute (as text)`string BeamMaxTargetYText`BeamFocusAreaXNumber attribute`double BeamFocusAreaX`BeamFocusAreaXTextNumber attribute (as text)`string BeamFocusAreaXText`BeamFocusAreaYNumber attribute`double BeamFocusAreaY`BeamFocusAreaYTextNumber attribute (as text)`string BeamFocusAreaYText`SharpCutOffGradientNumber attribute`int SharpCutOffGradient`SharpCutOffGradientTextNumber attribute (as text)`string SharpCutOffGradientText`AboveLightAreaXNumber attribute`double AboveLightAreaX`AboveLightAreaXTextNumber attribute (as text)`string AboveLightAreaXText`AboveLightAreaYNumber attribute`double AboveLightAreaY`AboveLightAreaYTextNumber attribute (as text)`string AboveLightAreaYText`GlareLightNumber attribute`int GlareLight`GlareLightTextNumber attribute (as text)`string GlareLightText`SwapVerticalRaysBoolean attribute`bool SwapVerticalRays`SubjectDeprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper`SpaceClaim.Api.v261.CustomObject Subject`OccurrenceGet the underlying CustomObject occurrence, associated to the API object wrapper in current API version`object Occurrence`NameGet or Set the name of the object`string Name`VisibleChange the visibility status (same behavior as checking/unchecking on the tree view item)`bool Visible`StatusInfoGet the status of the object (warning or error message)`string StatusInfo`IsUpToDateAsk if the object was modified since its last successful computation`bool IsUpToDate`## FreeformLens.FreeformLensFocalPoint

### Method

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

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed object`SpaceClaim.Api.v261.IDocObject LinkedObject`## FreeformLens.FreeformLensOpticalAxis

### Method

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

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed object`SpaceClaim.Api.v261.IDocObject LinkedObject`## FreeformLens.FreeformLensFrontFace

### Method

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

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed object`SpaceClaim.Api.v261.IDocObject LinkedObject`## FreeformLens.FreeformLensTargetOrigin

### Method

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

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed object`SpaceClaim.Api.v261.IDocObject LinkedObject`## FreeformLens.FreeformLensTargetXAxis

### Method

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

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed object`SpaceClaim.Api.v261.IDocObject LinkedObject`## FreeformLens.FreeformLensTargetYAxis

### Method

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

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed object`SpaceClaim.Api.v261.IDocObject LinkedObject`## FreeformLens.FreeformLensIntensityOpticalAxis

### Method

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

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed object`SpaceClaim.Api.v261.IDocObject LinkedObject`## FreeformLens.FreeformLensIntensityOrientationAxis

### Method

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

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed object`SpaceClaim.Api.v261.IDocObject LinkedObject`## FreeformLens.FreeformLensSourceBody

### Method

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

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed object`SpaceClaim.Api.v261.IDocObject LinkedObject`## FreestyleCircularLens

### Static method

NameDescriptionSyntaxFromSelectionConvert Items of a ScriptSelection to a list of Speos objects when their type is matching.`IEnumerable<SpeosDes.FreestyleCircularLens> FromSelection(IEnumerable<SpaceClaim.Api.v261.IDocObject> 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 component`SpeosDes.FreestyleCircularLens Create(object parent)`CreateCreate a new object in the active context`SpeosDes.FreestyleCircularLens Create()`### Method

NameDescriptionSyntaxCloneCreate a copy of this object in the active context`SpeosDes.FreestyleCircularLens Clone()`CopyToCreate a copy of this object and paste it to the specified destination`SpeosDes.FreestyleCircularLens CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)`AddGroupCall the 'AddGroup' command.`void AddGroup()`FindOccurrenceInActivePartSearch for occurrences of this object in the active Part`object FindOccurrenceInActivePart()`FindOccurrenceInContextOfSearch for occurrences of this object in the specified Part`SpaceClaim.Api.v261.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.v261.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 object`bool Delete()`GetChildSubjectsRetrieve all children as DocObjects`IEnumerable<SpaceClaim.Api.v261.CustomObject> GetChildSubjects()`GetChildrenRetrieve all direct children of a given type`IEnumerable<TSpecificApiType> GetChildren<TSpecificApiType>()`ComputeExecute the Compute command on the object`void Compute()`PublishParameterPublish or un-publish a number attribute as driving parameter`void 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 attribute`SpeosDes.OpticalFeatureStyleFreestyle Style`GeneralChild CustomObject attribute`SpeosDes.OpticalFeatureGeneral General`GroupsChildren CustomObjects attribute`SpeosDes.FreestyleCircularLens.FreestyleCircularLensGroups Groups`TirLensChildren CustomObjects attribute`SpeosDes.FreestyleCircularLens.FreestyleCircularLensTirLens TirLens`ManufacturingChild CustomObject attribute`SpeosDes.OpticalFeatureManufacturing Manufacturing`ExcelFileFile attribute`Speos.Foundation.Utils.File.FilePath ExcelFile`ExcelFileFullPathFile attribute (absolute full path)`string ExcelFileFullPath`SubjectDeprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper`SpaceClaim.Api.v261.CustomObject Subject`OccurrenceGet the underlying CustomObject occurrence, associated to the API object wrapper in current API version`object Occurrence`NameGet or Set the name of the object`string Name`VisibleChange the visibility status (same behavior as checking/unchecking on the tree view item)`bool Visible`StatusInfoGet the status of the object (warning or error message)`string StatusInfo`IsUpToDateAsk if the object was modified since its last successful computation`bool IsUpToDate`## FreestyleCircularLens.FreestyleCircularLensGroups

### Method

NameDescriptionSyntaxGetEnumeratorGet children CustomObjects enumeration`IEnumerator<SpeosDes.OpticalGroup> GetEnumerator()`AddNewCreate a new child CustomObject`SpeosDes.OpticalGroup AddNew(int insertIndex)`DeleteDelete a child CustomObject by index`void Delete(int index)`### Property

NameDescriptionSyntaxCountGet children CustomObjects count`int Count`ListGet children CustomObjects list`IReadOnlyCollection<SpeosDes.OpticalGroup> List`ItemGet child CustomObject by index`SpeosDes.OpticalGroup Item`ItemGet child CustomObject by index`SpeosDes.OpticalGroup Item`## FreestyleCircularLens.FreestyleCircularLensTirLens

### Method

NameDescriptionSyntaxGetEnumeratorGet children CustomObjects enumeration`IEnumerator<SpeosDes.TIRLens> GetEnumerator()`AddNewCreate a new child CustomObject`SpeosDes.TIRLens AddNew(int insertIndex)`DeleteDelete a child CustomObject by index`void Delete(int index)`### Property

NameDescriptionSyntaxCountGet children CustomObjects count`int Count`ListGet children CustomObjects list`IReadOnlyCollection<SpeosDes.TIRLens> List`ItemGet child CustomObject by index`SpeosDes.TIRLens Item`ItemGet child CustomObject by index`SpeosDes.TIRLens Item`## FreestyleCircularSurface

### Static method

NameDescriptionSyntaxFromSelectionConvert Items of a ScriptSelection to a list of Speos objects when their type is matching.`IEnumerable<SpeosDes.FreestyleCircularSurface> FromSelection(IEnumerable<SpaceClaim.Api.v261.IDocObject> 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 component`SpeosDes.FreestyleCircularSurface Create(object parent)`CreateCreate a new object in the active context`SpeosDes.FreestyleCircularSurface Create()`### Method

NameDescriptionSyntaxCloneCreate a copy of this object in the active context`SpeosDes.FreestyleCircularSurface Clone()`CopyToCreate a copy of this object and paste it to the specified destination`SpeosDes.FreestyleCircularSurface CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)`AddGroupCall the 'AddGroup' command.`void AddGroup()`FindOccurrenceInActivePartSearch for occurrences of this object in the active Part`object FindOccurrenceInActivePart()`FindOccurrenceInContextOfSearch for occurrences of this object in the specified Part`SpaceClaim.Api.v261.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.v261.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 object`bool Delete()`GetChildSubjectsRetrieve all children as DocObjects`IEnumerable<SpaceClaim.Api.v261.CustomObject> GetChildSubjects()`GetChildrenRetrieve all direct children of a given type`IEnumerable<TSpecificApiType> GetChildren<TSpecificApiType>()`ComputeExecute the Compute command on the object`void Compute()`PublishParameterPublish or un-publish a number attribute as driving parameter`void 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 attribute`SpeosDes.OpticalFeatureStyleFreestyle Style`GeneralChild CustomObject attribute`SpeosDes.OpticalFeatureGeneral General`GroupsChildren CustomObjects attribute`SpeosDes.FreestyleCircularSurface.FreestyleCircularSurfaceGroups Groups`TirLensChildren CustomObjects attribute`SpeosDes.FreestyleCircularSurface.FreestyleCircularSurfaceTirLens TirLens`ManufacturingChild CustomObject attribute`SpeosDes.OpticalFeatureManufacturing Manufacturing`ExcelFileFile attribute`Speos.Foundation.Utils.File.FilePath ExcelFile`ExcelFileFullPathFile attribute (absolute full path)`string ExcelFileFullPath`SubjectDeprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper`SpaceClaim.Api.v261.CustomObject Subject`OccurrenceGet the underlying CustomObject occurrence, associated to the API object wrapper in current API version`object Occurrence`NameGet or Set the name of the object`string Name`VisibleChange the visibility status (same behavior as checking/unchecking on the tree view item)`bool Visible`StatusInfoGet the status of the object (warning or error message)`string StatusInfo`IsUpToDateAsk if the object was modified since its last successful computation`bool IsUpToDate`## FreestyleCircularSurface.FreestyleCircularSurfaceGroups

### Method

NameDescriptionSyntaxGetEnumeratorGet children CustomObjects enumeration`IEnumerator<SpeosDes.OpticalGroup> GetEnumerator()`AddNewCreate a new child CustomObject`SpeosDes.OpticalGroup AddNew(int insertIndex)`DeleteDelete a child CustomObject by index`void Delete(int index)`### Property

NameDescriptionSyntaxCountGet children CustomObjects count`int Count`ListGet children CustomObjects list`IReadOnlyCollection<SpeosDes.OpticalGroup> List`ItemGet child CustomObject by index`SpeosDes.OpticalGroup Item`ItemGet child CustomObject by index`SpeosDes.OpticalGroup Item`## FreestyleCircularSurface.FreestyleCircularSurfaceTirLens

### Method

NameDescriptionSyntaxGetEnumeratorGet children CustomObjects enumeration`IEnumerator<SpeosDes.TIRLens> GetEnumerator()`AddNewCreate a new child CustomObject`SpeosDes.TIRLens AddNew(int insertIndex)`DeleteDelete a child CustomObject by index`void Delete(int index)`### Property

NameDescriptionSyntaxCountGet children CustomObjects count`int Count`ListGet children CustomObjects list`IReadOnlyCollection<SpeosDes.TIRLens> List`ItemGet child CustomObject by index`SpeosDes.TIRLens Item`ItemGet child CustomObject by index`SpeosDes.TIRLens Item`## FreestyleRectangularLens

### Static method

NameDescriptionSyntaxFromSelectionConvert Items of a ScriptSelection to a list of Speos objects when their type is matching.`IEnumerable<SpeosDes.FreestyleRectangularLens> FromSelection(IEnumerable<SpaceClaim.Api.v261.IDocObject> 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 component`SpeosDes.FreestyleRectangularLens Create(object parent)`CreateCreate a new object in the active context`SpeosDes.FreestyleRectangularLens Create()`### Method

NameDescriptionSyntaxCloneCreate a copy of this object in the active context`SpeosDes.FreestyleRectangularLens Clone()`CopyToCreate a copy of this object and paste it to the specified destination`SpeosDes.FreestyleRectangularLens CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)`AddGroupCall the 'AddGroup' command.`void AddGroup()`FindOccurrenceInActivePartSearch for occurrences of this object in the active Part`object FindOccurrenceInActivePart()`FindOccurrenceInContextOfSearch for occurrences of this object in the specified Part`SpaceClaim.Api.v261.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.v261.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 object`bool Delete()`GetChildSubjectsRetrieve all children as DocObjects`IEnumerable<SpaceClaim.Api.v261.CustomObject> GetChildSubjects()`GetChildrenRetrieve all direct children of a given type`IEnumerable<TSpecificApiType> GetChildren<TSpecificApiType>()`ComputeExecute the Compute command on the object`void Compute()`PublishParameterPublish or un-publish a number attribute as driving parameter`void 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 attribute`SpeosDes.OpticalFeatureStyleFreestyle Style`GeneralChild CustomObject attribute`SpeosDes.OpticalFeatureGeneral General`GroupsChildren CustomObjects attribute`SpeosDes.FreestyleRectangularLens.FreestyleRectangularLensGroups Groups`TirLensChildren CustomObjects attribute`SpeosDes.FreestyleRectangularLens.FreestyleRectangularLensTirLens TirLens`ManufacturingChild CustomObject attribute`SpeosDes.OpticalFeatureManufacturing Manufacturing`ExcelFileFile attribute`Speos.Foundation.Utils.File.FilePath ExcelFile`ExcelFileFullPathFile attribute (absolute full path)`string ExcelFileFullPath`SubjectDeprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper`SpaceClaim.Api.v261.CustomObject Subject`OccurrenceGet the underlying CustomObject occurrence, associated to the API object wrapper in current API version`object Occurrence`NameGet or Set the name of the object`string Name`VisibleChange the visibility status (same behavior as checking/unchecking on the tree view item)`bool Visible`StatusInfoGet the status of the object (warning or error message)`string StatusInfo`IsUpToDateAsk if the object was modified since its last successful computation`bool IsUpToDate`## FreestyleRectangularLens.FreestyleRectangularLensGroups

### Method

NameDescriptionSyntaxGetEnumeratorGet children CustomObjects enumeration`IEnumerator<SpeosDes.OpticalGroup> GetEnumerator()`AddNewCreate a new child CustomObject`SpeosDes.OpticalGroup AddNew(int insertIndex)`DeleteDelete a child CustomObject by index`void Delete(int index)`### Property

NameDescriptionSyntaxCountGet children CustomObjects count`int Count`ListGet children CustomObjects list`IReadOnlyCollection<SpeosDes.OpticalGroup> List`ItemGet child CustomObject by index`SpeosDes.OpticalGroup Item`ItemGet child CustomObject by index`SpeosDes.OpticalGroup Item`## FreestyleRectangularLens.FreestyleRectangularLensTirLens

### Method

NameDescriptionSyntaxGetEnumeratorGet children CustomObjects enumeration`IEnumerator<SpeosDes.TIRLens> GetEnumerator()`AddNewCreate a new child CustomObject`SpeosDes.TIRLens AddNew(int insertIndex)`DeleteDelete a child CustomObject by index`void Delete(int index)`### Property

NameDescriptionSyntaxCountGet children CustomObjects count`int Count`ListGet children CustomObjects list`IReadOnlyCollection<SpeosDes.TIRLens> List`ItemGet child CustomObject by index`SpeosDes.TIRLens Item`ItemGet child CustomObject by index`SpeosDes.TIRLens Item`## FreestyleRectangularSurface

### Static method

NameDescriptionSyntaxFromSelectionConvert Items of a ScriptSelection to a list of Speos objects when their type is matching.`IEnumerable<SpeosDes.FreestyleRectangularSurface> FromSelection(IEnumerable<SpaceClaim.Api.v261.IDocObject> 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 component`SpeosDes.FreestyleRectangularSurface Create(object parent)`CreateCreate a new object in the active context`SpeosDes.FreestyleRectangularSurface Create()`### Method

NameDescriptionSyntaxCloneCreate a copy of this object in the active context`SpeosDes.FreestyleRectangularSurface Clone()`CopyToCreate a copy of this object and paste it to the specified destination`SpeosDes.FreestyleRectangularSurface CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)`AddGroupCall the 'AddGroup' command.`void AddGroup()`FindOccurrenceInActivePartSearch for occurrences of this object in the active Part`object FindOccurrenceInActivePart()`FindOccurrenceInContextOfSearch for occurrences of this object in the specified Part`SpaceClaim.Api.v261.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.v261.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 object`bool Delete()`GetChildSubjectsRetrieve all children as DocObjects`IEnumerable<SpaceClaim.Api.v261.CustomObject> GetChildSubjects()`GetChildrenRetrieve all direct children of a given type`IEnumerable<TSpecificApiType> GetChildren<TSpecificApiType>()`ComputeExecute the Compute command on the object`void Compute()`PublishParameterPublish or un-publish a number attribute as driving parameter`void 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 attribute`SpeosDes.OpticalFeatureStyleFreestyle Style`GeneralChild CustomObject attribute`SpeosDes.OpticalFeatureGeneral General`GroupsChildren CustomObjects attribute`SpeosDes.FreestyleRectangularSurface.FreestyleRectangularSurfaceGroups Groups`TirLensChildren CustomObjects attribute`SpeosDes.FreestyleRectangularSurface.FreestyleRectangularSurfaceTirLens TirLens`ManufacturingChild CustomObject attribute`SpeosDes.OpticalFeatureManufacturing Manufacturing`ExcelFileFile attribute`Speos.Foundation.Utils.File.FilePath ExcelFile`ExcelFileFullPathFile attribute (absolute full path)`string ExcelFileFullPath`SubjectDeprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper`SpaceClaim.Api.v261.CustomObject Subject`OccurrenceGet the underlying CustomObject occurrence, associated to the API object wrapper in current API version`object Occurrence`NameGet or Set the name of the object`string Name`VisibleChange the visibility status (same behavior as checking/unchecking on the tree view item)`bool Visible`StatusInfoGet the status of the object (warning or error message)`string StatusInfo`IsUpToDateAsk if the object was modified since its last successful computation`bool IsUpToDate`## FreestyleRectangularSurface.FreestyleRectangularSurfaceGroups

### Method

NameDescriptionSyntaxGetEnumeratorGet children CustomObjects enumeration`IEnumerator<SpeosDes.OpticalGroup> GetEnumerator()`AddNewCreate a new child CustomObject`SpeosDes.OpticalGroup AddNew(int insertIndex)`DeleteDelete a child CustomObject by index`void Delete(int index)`### Property

NameDescriptionSyntaxCountGet children CustomObjects count`int Count`ListGet children CustomObjects list`IReadOnlyCollection<SpeosDes.OpticalGroup> List`ItemGet child CustomObject by index`SpeosDes.OpticalGroup Item`ItemGet child CustomObject by index`SpeosDes.OpticalGroup Item`## FreestyleRectangularSurface.FreestyleRectangularSurfaceTirLens

### Method

NameDescriptionSyntaxGetEnumeratorGet children CustomObjects enumeration`IEnumerator<SpeosDes.TIRLens> GetEnumerator()`AddNewCreate a new child CustomObject`SpeosDes.TIRLens AddNew(int insertIndex)`DeleteDelete a child CustomObject by index`void Delete(int index)`### Property

NameDescriptionSyntaxCountGet children CustomObjects count`int Count`ListGet children CustomObjects list`IReadOnlyCollection<SpeosDes.TIRLens> List`ItemGet child CustomObject by index`SpeosDes.TIRLens Item`ItemGet child CustomObject by index`SpeosDes.TIRLens Item`## HoneycombLens

### Static method

NameDescriptionSyntaxFromSelectionConvert Items of a ScriptSelection to a list of Speos objects when their type is matching.`IEnumerable<SpeosDes.HoneycombLens> FromSelection(IEnumerable<SpaceClaim.Api.v261.IDocObject> 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 component`SpeosDes.HoneycombLens Create(object parent)`CreateCreate a new object in the active context`SpeosDes.HoneycombLens Create()`### Method

NameDescriptionSyntaxCloneCreate a copy of this object in the active context`SpeosDes.HoneycombLens Clone()`CopyToCreate a copy of this object and paste it to the specified destination`SpeosDes.HoneycombLens CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)`AddGroupCall the 'AddGroup' command.`void AddGroup()`FindOccurrenceInActivePartSearch for occurrences of this object in the active Part`object FindOccurrenceInActivePart()`FindOccurrenceInContextOfSearch for occurrences of this object in the specified Part`SpaceClaim.Api.v261.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.v261.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 object`bool Delete()`GetChildSubjectsRetrieve all children as DocObjects`IEnumerable<SpaceClaim.Api.v261.CustomObject> GetChildSubjects()`GetChildrenRetrieve all direct children of a given type`IEnumerable<TSpecificApiType> GetChildren<TSpecificApiType>()`ComputeExecute the Compute command on the object`void Compute()`PublishParameterPublish or un-publish a number attribute as driving parameter`void 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 attribute`SpeosDes.OpticalFeatureStyleHoneycomb Style`GeneralChild CustomObject attribute`SpeosDes.OpticalFeatureGeneral General`GroupsChildren CustomObjects attribute`SpeosDes.HoneycombLens.HoneycombLensGroups Groups`TirLensChildren CustomObjects attribute`SpeosDes.HoneycombLens.HoneycombLensTirLens TirLens`ManufacturingChild CustomObject attribute`SpeosDes.OpticalFeatureManufacturing Manufacturing`ExcelFileFile attribute`Speos.Foundation.Utils.File.FilePath ExcelFile`ExcelFileFullPathFile attribute (absolute full path)`string ExcelFileFullPath`SubjectDeprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper`SpaceClaim.Api.v261.CustomObject Subject`OccurrenceGet the underlying CustomObject occurrence, associated to the API object wrapper in current API version`object Occurrence`NameGet or Set the name of the object`string Name`VisibleChange the visibility status (same behavior as checking/unchecking on the tree view item)`bool Visible`StatusInfoGet the status of the object (warning or error message)`string StatusInfo`IsUpToDateAsk if the object was modified since its last successful computation`bool IsUpToDate`## HoneycombLens.HoneycombLensGroups

### Method

NameDescriptionSyntaxGetEnumeratorGet children CustomObjects enumeration`IEnumerator<SpeosDes.OpticalGroup> GetEnumerator()`AddNewCreate a new child CustomObject`SpeosDes.OpticalGroup AddNew(int insertIndex)`DeleteDelete a child CustomObject by index`void Delete(int index)`### Property

NameDescriptionSyntaxCountGet children CustomObjects count`int Count`ListGet children CustomObjects list`IReadOnlyCollection<SpeosDes.OpticalGroup> List`ItemGet child CustomObject by index`SpeosDes.OpticalGroup Item`ItemGet child CustomObject by index`SpeosDes.OpticalGroup Item`## HoneycombLens.HoneycombLensTirLens

### Method

NameDescriptionSyntaxGetEnumeratorGet children CustomObjects enumeration`IEnumerator<SpeosDes.TIRLens> GetEnumerator()`AddNewCreate a new child CustomObject`SpeosDes.TIRLens AddNew(int insertIndex)`DeleteDelete a child CustomObject by index`void Delete(int index)`### Property

NameDescriptionSyntaxCountGet children CustomObjects count`int Count`ListGet children CustomObjects list`IReadOnlyCollection<SpeosDes.TIRLens> List`ItemGet child CustomObject by index`SpeosDes.TIRLens Item`ItemGet child CustomObject by index`SpeosDes.TIRLens Item`## HUDOD

### Static method

NameDescriptionSyntaxFromSelectionConvert Items of a ScriptSelection to a list of Speos objects when their type is matching.`IEnumerable<SpeosDes.HUDOD> FromSelection(IEnumerable<SpaceClaim.Api.v261.IDocObject> 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 component`SpeosDes.HUDOD Create(object parent)`CreateCreate a new object in the active context`SpeosDes.HUDOD Create()`### Method

NameDescriptionSyntaxCloneCreate a copy of this object in the active context`SpeosDes.HUDOD Clone()`CopyToCreate a copy of this object and paste it to the specified destination`SpeosDes.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 files`System.String[] GetResultFilePaths()`FindOccurrenceInActivePartSearch for occurrences of this object in the active Part`object FindOccurrenceInActivePart()`FindOccurrenceInContextOfSearch for occurrences of this object in the specified Part`SpaceClaim.Api.v261.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.v261.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 object`bool Delete()`GetChildSubjectsRetrieve all children as DocObjects`IEnumerable<SpaceClaim.Api.v261.CustomObject> GetChildSubjects()`GetChildrenRetrieve all direct children of a given type`IEnumerable<TSpecificApiType> GetChildren<TSpecificApiType>()`ComputeExecute the Compute command on the object`void Compute()`PublishParameterPublish or un-publish a number attribute as driving parameter`void 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 attribute`SpeosDes.HUDOD.HUDODVehicleAxis VehicleAxis`ReverseVehiculeAxisDirectionBoolean attribute`bool ReverseVehiculeAxisDirection`TopAxisLink attribute`SpeosDes.HUDOD.HUDODTopAxis TopAxis`ReverseTopAxisDirectionBoolean attribute`bool ReverseTopAxisDirection`ManufacturingXNumber attribute`int ManufacturingX`ManufacturingXTextNumber attribute (as text)`string ManufacturingXText`ManufacturingYNumber attribute`int ManufacturingY`ManufacturingYTextNumber attribute (as text)`string ManufacturingYText`EyeboxCenterLink attribute`SpeosDes.HUDOD.HUDODEyeboxCenter EyeboxCenter`EyeboxOrientationTypeEnum attribute`SpeosDes.HUDOD.EnumEyeboxOrientationType EyeboxOrientationType`EyeboxOrientationTypeIndexEnum attribute (as index)`int EyeboxOrientationTypeIndex`EBHorizontalSizeNumber attribute`double EBHorizontalSize`EBHorizontalSizeTextNumber attribute (as text)`string EBHorizontalSizeText`EBHorizontalSamplingNumber attribute`int EBHorizontalSampling`EBHorizontalSamplingTextNumber attribute (as text)`string EBHorizontalSamplingText`EBHorizontalResolutionNumber attribute`double EBHorizontalResolution`EBHorizontalResolutionTextNumber attribute (as text)`string EBHorizontalResolutionText`EBVerticalSizeNumber attribute`double EBVerticalSize`EBVerticalSizeTextNumber attribute (as text)`string EBVerticalSizeText`EBVerticalSamplingNumber attribute`int EBVerticalSampling`EBVerticalSamplingTextNumber attribute (as text)`string EBVerticalSamplingText`EBVerticalResolutionNumber attribute`double EBVerticalResolution`EBVerticalResolutionTextNumber attribute (as text)`string EBVerticalResolutionText`EyeboxConfigPositionDirectionTypeEnum attribute`SpeosDes.HUDOD.EnumEyeboxConfigPositionDirectionType EyeboxConfigPositionDirectionType`EyeboxConfigPositionDirectionTypeIndexEnum attribute (as index)`int EyeboxConfigPositionDirectionTypeIndex`EBConfigurationsChildren attribute`SpeosDes.HUDOD.HUDODEBConfigurations EBConfigurations`TIVirtualImageDistanceNumber attribute`double TIVirtualImageDistance`TIVirtualImageDistanceTextNumber attribute (as text)`string TIVirtualImageDistanceText`TILookOverAngleNumber attribute`double TILookOverAngle`TILookOverAngleTextNumber attribute (as text)`string TILookOverAngleText`TILookDownAngleNumber attribute`double TILookDownAngle`TILookDownAngleTextNumber attribute (as text)`string TILookDownAngleText`TargetImageModeTypeEnum attribute`SpeosDes.HUDOD.EnumTargetImageModeType TargetImageModeType`TargetImageModeTypeIndexEnum attribute (as index)`int TargetImageModeTypeIndex`TIHorizontalSizeNumber attribute`double TIHorizontalSize`TIHorizontalSizeTextNumber attribute (as text)`string TIHorizontalSizeText`TIVerticalSizeNumber attribute`double TIVerticalSize`TIVerticalSizeTextNumber attribute (as text)`string TIVerticalSizeText`TIHorizontalFOVNumber attribute`double TIHorizontalFOV`TIHorizontalFOVTextNumber attribute (as text)`string TIHorizontalFOVText`TIVerticalFOVNumber attribute`double TIVerticalFOV`TIVerticalFOVTextNumber attribute (as text)`string TIVerticalFOVText`WindshieldInnerSurfaceLink attribute`SpeosDes.HUDOD.HUDODWindshieldInnerSurface WindshieldInnerSurface`ProjectorsChildren attribute`SpeosDes.HUDOD.HUDODProjectors Projectors`PGUHorizontalSamplingNumber attribute`int PGUHorizontalSampling`PGUHorizontalSamplingTextNumber attribute (as text)`string PGUHorizontalSamplingText`PGUVerticalSamplingNumber attribute`int PGUVerticalSampling`PGUVerticalSamplingTextNumber attribute (as text)`string PGUVerticalSamplingText`PGUCharacteristicsTypeEnum attribute`SpeosDes.HUDOD.EnumPGUCharacteristicsType PGUCharacteristicsType`PGUCharacteristicsTypeIndexEnum attribute (as index)`int PGUCharacteristicsTypeIndex`PGUHorizontalSizeNumber attribute`double PGUHorizontalSize`PGUHorizontalSizeTextNumber attribute (as text)`string PGUHorizontalSizeText`PGUHorizontalResolutionNumber attribute`int PGUHorizontalResolution`PGUHorizontalResolutionTextNumber attribute (as text)`string PGUHorizontalResolutionText`PGUVerticalSizeNumber attribute`double PGUVerticalSize`PGUVerticalSizeTextNumber attribute (as text)`string PGUVerticalSizeText`PGUVerticalResolutionNumber attribute`int PGUVerticalResolution`PGUVerticalResolutionTextNumber attribute (as text)`string PGUVerticalResolutionText`AdvancedParametersAccess the HUD Optical Design dynamic parameters`SpeosDes.HUDOD.DynamicParametersAttribute AdvancedParameters`SubjectDeprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper`SpaceClaim.Api.v261.CustomObject Subject`OccurrenceGet the underlying CustomObject occurrence, associated to the API object wrapper in current API version`object Occurrence`NameGet or Set the name of the object`string Name`VisibleChange the visibility status (same behavior as checking/unchecking on the tree view item)`bool Visible`StatusInfoGet the status of the object (warning or error message)`string StatusInfo`IsUpToDateAsk if the object was modified since its last successful computation`bool IsUpToDate`## HUDOD.HUDODVehicleAxis

### Method

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

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed object`SpaceClaim.Api.v261.IDocObject LinkedObject`## HUDOD.HUDODTopAxis

### Method

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

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed object`SpaceClaim.Api.v261.IDocObject LinkedObject`## HUDOD.HUDODEyeboxCenter

### Method

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

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed object`SpaceClaim.Api.v261.IDocObject LinkedObject`## HUDOD.HUDODEBConfigurations

### Method

NameDescriptionSyntaxSetChildren attribute: Set from an array of script objects`bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)`SetChildren attribute: Set from an array of document objects`bool Set(SpaceClaim.Api.v261.IDocObject[] selectedObjects)`SetChildren attribute: Set from an array of objects (IDocObject type from unspecified version)`bool Set(System.Object[] docObjectsFromPreviousVersion)`GetEnumeratorChildren attribute: Get children enumeration`IEnumerator<SpeosDes.EyeboxConfiguration> GetEnumerator()`AddNewChildren attribute: Create a new child object`SpeosDes.EyeboxConfiguration AddNew(int insertIndex)`DeleteChildren attribute: Delete a child object by index`bool Delete(int index)`ClearChildren attribute: Empty the list`void Clear()`SelectAllChildren attribute: Create children for all objects that are compatible with link selection.`void SelectAll()`### Property

NameDescriptionSyntaxLinkedObjectsChildren attribute: Get linked objects`IReadOnlyCollection<SpaceClaim.Api.v261.IDocObject> LinkedObjects`CountChildren attribute: Get children count`int Count`ListChildren attribute: Get children collection`IReadOnlyCollection<SpeosDes.EyeboxConfiguration> List`ItemChildren attribute: Get child by index`SpeosDes.EyeboxConfiguration Item`## HUDOD.HUDODWindshieldInnerSurface

### Method

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

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed object`SpaceClaim.Api.v261.IDocObject LinkedObject`## HUDOD.HUDODProjectors

### Method

NameDescriptionSyntaxSetChildren attribute: Set from an array of script objects`bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)`SetChildren attribute: Set from an array of document objects`bool Set(SpaceClaim.Api.v261.IDocObject[] selectedObjects)`SetChildren attribute: Set from an array of objects (IDocObject type from unspecified version)`bool Set(System.Object[] docObjectsFromPreviousVersion)`GetEnumeratorChildren attribute: Get children enumeration`IEnumerator<SpeosDes.HUDProjectorElement> GetEnumerator()`AddNewChildren attribute: Create a new child object`SpeosDes.HUDProjectorElement AddNew(int insertIndex)`DeleteChildren attribute: Delete a child object by index`bool Delete(int index)`ClearChildren attribute: Empty the list`void Clear()`SelectAllChildren attribute: Create children for all objects that are compatible with link selection.`void SelectAll()`### Property

NameDescriptionSyntaxLinkedObjectsChildren attribute: Get linked objects`IReadOnlyCollection<SpaceClaim.Api.v261.IDocObject> LinkedObjects`CountChildren attribute: Get children count`int Count`ListChildren attribute: Get children collection`IReadOnlyCollection<SpeosDes.HUDProjectorElement> List`ItemChildren attribute: Get child by index`SpeosDes.HUDProjectorElement Item`## HUDOD.DynamicParametersAttribute

### Method

NameDescriptionSyntaxGetEnumeratorHUD Optical Design dynamic parameters enumerator`IEnumerator<string> GetEnumerator()`### Property

NameDescriptionSyntaxItemHUD Optical Design dynamic parameters, get by index operator`double Item`## HUDProjectorElement

### Static method

NameDescriptionSyntaxCreateCreate a new object of this type`SpeosDes.HUDProjectorElement Create()`### Method

NameDescriptionSyntaxToString`string ToString()`### Property

NameDescriptionSyntaxNameString attribute`string Name`ProjectorTypeEnum attribute`SpeosDes.HUDProjectorElement.EnumProjectorType ProjectorType`ProjectorTypeIndexEnum attribute (as index)`int ProjectorTypeIndex`DistanceNumber attribute`double Distance`DistanceTextNumber attribute (as text)`string DistanceText`HorizontalAngleNumber attribute`double HorizontalAngle`HorizontalAngleTextNumber attribute (as text)`string HorizontalAngleText`MultiConfigBoolean attribute`bool MultiConfig`VerticalAngleNumber attribute`double VerticalAngle`VerticalAngleTextNumber attribute (as text)`string VerticalAngleText`## LightGuide

### Method

NameDescriptionSyntaxGetEndAngleTypePossibleValuesString list attribute: List possible values`IEnumerable<string> GetEndAngleTypePossibleValues()`GetStartRadiusTypePossibleValuesString list attribute: List possible values`IEnumerable<string> GetStartRadiusTypePossibleValues()`GetEndRadiusTypePossibleValuesString list attribute: List possible values`IEnumerable<string> GetEndRadiusTypePossibleValues()`GetPrismHeightTypePossibleValuesString list attribute: List possible values`IEnumerable<string> GetPrismHeightTypePossibleValues()`GetMillingTypePossibleValuesString list attribute: List possible values`IEnumerable<string> GetMillingTypePossibleValues()`GetBottomPrismMillingTypePossibleValuesString list attribute: List possible values`IEnumerable<string> GetBottomPrismMillingTypePossibleValues()`GetSideMillingTypePossibleValuesString list attribute: List possible values`IEnumerable<string> GetSideMillingTypePossibleValues()`GetBorderMillingTypePossibleValuesString list attribute: List possible values`IEnumerable<string> GetBorderMillingTypePossibleValues()`ExportAsCSVFile`void ExportAsCSVFile(string csvFilePath)`CloneCreate a copy of this object in the active context`SpeosDes.LightGuide Clone()`CopyToCreate a copy of this object and paste it to the specified destination`SpeosDes.LightGuide CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)`GetStepTypePossibleValuesString list attribute: List possible values`IEnumerable<string> GetStepTypePossibleValues()`GetLengthTypePossibleValuesString list attribute: List possible values`IEnumerable<string> GetLengthTypePossibleValues()`GetTrimmingRatioTypePossibleValuesString list attribute: List possible values`IEnumerable<string> GetTrimmingRatioTypePossibleValues()`GetPeakTrimmingRatioTypePossibleValuesString list attribute: List possible values`IEnumerable<string> GetPeakTrimmingRatioTypePossibleValues()`GetOffsetTypePossibleValuesString list attribute: List possible values`IEnumerable<string> GetOffsetTypePossibleValues()`GetWidthTypePossibleValuesString list attribute: List possible values`IEnumerable<string> GetWidthTypePossibleValues()`GetStartAngleTypePossibleValuesString list attribute: List possible values`IEnumerable<string> GetStartAngleTypePossibleValues()`FindOccurrenceInActivePartSearch for occurrences of this object in the active Part`object FindOccurrenceInActivePart()`FindOccurrenceInContextOfSearch for occurrences of this object in the specified Part`SpaceClaim.Api.v261.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.v261.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 object`bool Delete()`GetChildSubjectsRetrieve all children as DocObjects`IEnumerable<SpaceClaim.Api.v261.CustomObject> GetChildSubjects()`GetChildrenRetrieve all direct children of a given type`IEnumerable<TSpecificApiType> GetChildren<TSpecificApiType>()`ComputeExecute the Compute command on the object`void Compute()`PublishParameterPublish or un-publish a number attribute as driving parameter`void 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<SpeosDes.LightGuide> FromSelection(IEnumerable<SpaceClaim.Api.v261.IDocObject> 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 component`SpeosDes.LightGuide Create(object parent)`CreateCreate a new object in the active context`SpeosDes.LightGuide Create()`### Property

NameDescriptionSyntaxGuideCurveLinks attribute`SpeosDes.LightGuide.LightGuideGuideCurve GuideCurve`ReverseGuideCurveDirectionBoolean attribute`bool ReverseGuideCurveDirection`MultipleOpticalAxisChildren attribute`SpeosDes.LightGuide.LightGuideMultipleOpticalAxis MultipleOpticalAxis`BodyTypeEnum attribute`SpeosDes.LightGuide.EnumBodyType BodyType`BodyTypeIndexEnum attribute (as index)`int BodyTypeIndex`BodyProfileDiameterNumber attribute`double BodyProfileDiameter`BodyProfileDiameterTextNumber attribute (as text)`string BodyProfileDiameterText`CustomBodyLink attribute`SpeosDes.LightGuide.LightGuideCustomBody CustomBody`BodyProfileDiameterConfigurationsChildren attribute`SpeosDes.LightGuide.LightGuideBodyProfileDiameterConfigurations BodyProfileDiameterConfigurations`ExtraBodyHeightNumber attribute`double ExtraBodyHeight`ExtraBodyHeightTextNumber attribute (as text)`string ExtraBodyHeightText`BodyProfileNumber attribute`SpeosDes.LightGuide.LightGuideBodyProfile BodyProfile`PrismsOrientationTypeEnum attribute`SpeosDes.LightGuide.EnumPrismsOrientationType PrismsOrientationType`PrismsOrientationTypeIndexEnum attribute (as index)`int PrismsOrientationTypeIndex`OpticalAxisLink attribute`SpeosDes.LightGuide.LightGuideOpticalAxis OpticalAxis`ReverseOpticalAxisDirectionBoolean attribute`bool ReverseOpticalAxisDirection`OrientationSurfaceLink attribute`SpeosDes.LightGuide.LightGuideOrientationSurface OrientationSurface`PrismsOperationTypeEnum attribute`SpeosDes.LightGuide.EnumPrismsOperationType PrismsOperationType`PrismsOperationTypeIndexEnum attribute (as index)`int PrismsOperationTypeIndex`RefractiveIndexNumber attribute`double RefractiveIndex`RefractiveIndexTextNumber attribute (as text)`string RefractiveIndexText`DistancesTypeEnum attribute`SpeosDes.LightGuide.EnumDistancesType DistancesType`DistancesTypeIndexEnum attribute (as index)`int DistancesTypeIndex`ProjectionAxisLink attribute`SpeosDes.LightGuide.LightGuideProjectionAxis ProjectionAxis`DistanceStartNumber attribute`double DistanceStart`DistanceStartTextNumber attribute (as text)`string DistanceStartText`DistanceEndNumber attribute`double DistanceEnd`DistanceEndTextNumber attribute (as text)`string DistanceEndText`StepTypeString list selection attribute`string StepType`StepValueNumber attribute`double StepValue`StepValueTextNumber attribute (as text)`string StepValueText`StepConfigurationsChildren attribute`SpeosDes.LightGuide.LightGuideStepConfigurations StepConfigurations`LengthTypeString list selection attribute`string LengthType`LengthValueNumber attribute`double LengthValue`LengthValueTextNumber attribute (as text)`string LengthValueText`LengthConfigurationsChildren attribute`SpeosDes.LightGuide.LightGuideLengthConfigurations LengthConfigurations`TrimmingRatioTypeString list selection attribute`string TrimmingRatioType`TrimmingRatioValueNumber attribute`double TrimmingRatioValue`TrimmingRatioValueTextNumber attribute (as text)`string TrimmingRatioValueText`TrimmingRatioConfigurationsChildren attribute`SpeosDes.LightGuide.LightGuideTrimmingRatioConfigurations TrimmingRatioConfigurations`PeakTrimmingRatioTypeString list selection attribute`string PeakTrimmingRatioType`PeakTrimmingRatioValueNumber attribute`double PeakTrimmingRatioValue`PeakTrimmingRatioValueTextNumber attribute (as text)`string PeakTrimmingRatioValueText`PeakTrimmingRatioConfigurationsChildren attribute`SpeosDes.LightGuide.LightGuidePeakTrimmingRatioConfigurations PeakTrimmingRatioConfigurations`OffsetTypeString list selection attribute`string OffsetType`OffsetValueNumber attribute`double OffsetValue`OffsetValueTextNumber attribute (as text)`string OffsetValueText`OffsetConfigurationsChildren attribute`SpeosDes.LightGuide.LightGuideOffsetConfigurations OffsetConfigurations`WidthTypeString list selection attribute`string WidthType`WidthValueNumber attribute`double WidthValue`WidthValueTextNumber attribute (as text)`string WidthValueText`WidthConfigurationsChildren attribute`SpeosDes.LightGuide.LightGuideWidthConfigurations WidthConfigurations`StartAngleTypeString list selection attribute`string StartAngleType`StartAngleValueNumber attribute`double StartAngleValue`StartAngleValueTextNumber attribute (as text)`string StartAngleValueText`StartAngleConfigurationsChildren attribute`SpeosDes.LightGuide.LightGuideStartAngleConfigurations StartAngleConfigurations`EndAngleTypeString list selection attribute`string EndAngleType`EndAngleValueNumber attribute`double EndAngleValue`EndAngleValueTextNumber attribute (as text)`string EndAngleValueText`EndAngleConfigurationsChildren attribute`SpeosDes.LightGuide.LightGuideEndAngleConfigurations EndAngleConfigurations`StartRadiusTypeString list selection attribute`string StartRadiusType`StartRadiusValueNumber attribute`double StartRadiusValue`StartRadiusValueTextNumber attribute (as text)`string StartRadiusValueText`StartRadiusConfigurationsChildren attribute`SpeosDes.LightGuide.LightGuideStartRadiusConfigurations StartRadiusConfigurations`EndRadiusTypeString list selection attribute`string EndRadiusType`EndRadiusValueNumber attribute`double EndRadiusValue`EndRadiusValueTextNumber attribute (as text)`string EndRadiusValueText`EndRadiusConfigurationsChildren attribute`SpeosDes.LightGuide.LightGuideEndRadiusConfigurations EndRadiusConfigurations`CSVFileFile attribute`string CSVFile`CSVFileFullPathFile attribute (absolute full path)`string CSVFileFullPath`DraftingTypeEnum attribute`SpeosDes.LightGuide.EnumDraftingType DraftingType`DraftingTypeIndexEnum attribute (as index)`int DraftingTypeIndex`DemoldingOrientationLink attribute`SpeosDes.LightGuide.LightGuideDemoldingOrientation DemoldingOrientation`ReverseDemoldingDirectionBoolean attribute`bool ReverseDemoldingDirection`DraftAngleNumber attribute`double DraftAngle`DraftAngleTextNumber attribute (as text)`string DraftAngleText`PrismHeightTypeString list selection attribute`string PrismHeightType`PrismHeightValueNumber attribute`double PrismHeightValue`PrismHeightValueTextNumber attribute (as text)`string PrismHeightValueText`PrismHeightConfigurationsChildren attribute`SpeosDes.LightGuide.LightGuidePrismHeightConfigurations PrismHeightConfigurations`NbPrismsNumber attribute`int NbPrisms`NbPrismsTextNumber attribute (as text)`string NbPrismsText`MillingTypeString list selection attribute`string MillingType`MillingValueNumber attribute`double MillingValue`MillingValueTextNumber attribute (as text)`string MillingValueText`MillingConfigurationsChildren attribute`SpeosDes.LightGuide.LightGuideMillingConfigurations MillingConfigurations`BottomPrismMillingTypeString list selection attribute`string BottomPrismMillingType`BottomPrismMillingValueNumber attribute`double BottomPrismMillingValue`BottomPrismMillingValueTextNumber attribute (as text)`string BottomPrismMillingValueText`BottomPrismMillingConfigurationsChildren attribute`SpeosDes.LightGuide.LightGuideBottomPrismMillingConfigurations BottomPrismMillingConfigurations`SideMillingTypeString list selection attribute`string SideMillingType`SideMillingValueNumber attribute`double SideMillingValue`SideMillingValueTextNumber attribute (as text)`string SideMillingValueText`BorderMillingTypeString list selection attribute`string BorderMillingType`BorderMillingValueNumber attribute`double BorderMillingValue`BorderMillingValueTextNumber attribute (as text)`string BorderMillingValueText`SubjectDeprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper`SpaceClaim.Api.v261.CustomObject Subject`OccurrenceGet the underlying CustomObject occurrence, associated to the API object wrapper in current API version`object Occurrence`NameGet or Set the name of the object`string Name`VisibleChange the visibility status (same behavior as checking/unchecking on the tree view item)`bool Visible`StatusInfoGet the status of the object (warning or error message)`string StatusInfo`IsUpToDateAsk if the object was modified since its last successful computation`bool IsUpToDate`## LightGuide.LightGuideGuideCurve

### Method

NameDescriptionSyntaxSetLinks attribute: Link to an array of script objects`bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)`SetLinks attribute: Link to an array of document objects`bool Set(SpaceClaim.Api.v261.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 links`void Clear()`SelectAllLinks attribute: Link to all compatible objects in the active context`void SelectAll()`### Property

NameDescriptionSyntaxLinkedObjectsLinks attribute: Get the pointed document objects`IReadOnlyCollection<SpaceClaim.Api.v261.IDocObject> LinkedObjects`ItemLinks attribute: Get a pointed document object by index`SpaceClaim.Api.v261.IDocObject Item`CountLinks attribute: Get the links count`int Count`## LightGuide.LightGuideMultipleOpticalAxis

### Method

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

NameDescriptionSyntaxLinkedObjectsChildren attribute: Get linked objects`IReadOnlyCollection<SpaceClaim.Api.v261.IDocObject> LinkedObjects`CountChildren attribute: Get children count`int Count`ListChildren attribute: Get children collection`IReadOnlyCollection<SpeosDes.MultipleOpticalAxis> List`ItemChildren attribute: Get child by index`SpeosDes.MultipleOpticalAxis Item`## LightGuide.LightGuideCustomBody

### Method

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

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed object`SpaceClaim.Api.v261.IDocObject LinkedObject`## LightGuide.LightGuideBodyProfileDiameterConfigurations

### Method

NameDescriptionSyntaxSetChildren attribute: Set from an array of script objects`bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)`SetChildren attribute: Set from an array of document objects`bool Set(SpaceClaim.Api.v261.IDocObject[] selectedObjects)`SetChildren attribute: Set from an array of objects (IDocObject type from unspecified version)`bool Set(System.Object[] docObjectsFromPreviousVersion)`GetEnumeratorChildren attribute: Get children enumeration`IEnumerator<SpeosDes.ControlPointConfiguration> GetEnumerator()`AddNewChildren attribute: Create a new child object`SpeosDes.ControlPointConfiguration AddNew(int insertIndex)`DeleteChildren attribute: Delete a child object by index`bool Delete(int index)`ClearChildren attribute: Empty the list`void Clear()`SelectAllChildren attribute: Create children for all objects that are compatible with link selection.`void SelectAll()`### Property

NameDescriptionSyntaxLinkedObjectsChildren attribute: Get linked objects`IReadOnlyCollection<SpaceClaim.Api.v261.IDocObject> LinkedObjects`CountChildren attribute: Get children count`int Count`ListChildren attribute: Get children collection`IReadOnlyCollection<SpeosDes.ControlPointConfiguration> List`ItemChildren attribute: Get child by index`SpeosDes.ControlPointConfiguration Item`## LightGuide.LightGuideBodyProfile

### Method

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

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed object`SpaceClaim.Api.v261.IDocObject LinkedObject`## LightGuide.LightGuideOpticalAxis

### Method

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

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed object`SpaceClaim.Api.v261.IDocObject LinkedObject`## LightGuide.LightGuideOrientationSurface

### Method

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

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed object`SpaceClaim.Api.v261.IDocObject LinkedObject`## LightGuide.LightGuideProjectionAxis

### Method

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

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed object`SpaceClaim.Api.v261.IDocObject LinkedObject`## LightGuide.LightGuideStepConfigurations

### Method

NameDescriptionSyntaxSetChildren attribute: Set from an array of script objects`bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)`SetChildren attribute: Set from an array of document objects`bool Set(SpaceClaim.Api.v261.IDocObject[] selectedObjects)`SetChildren attribute: Set from an array of objects (IDocObject type from unspecified version)`bool Set(System.Object[] docObjectsFromPreviousVersion)`GetEnumeratorChildren attribute: Get children enumeration`IEnumerator<SpeosDes.ControlPointConfiguration> GetEnumerator()`AddNewChildren attribute: Create a new child object`SpeosDes.ControlPointConfiguration AddNew(int insertIndex)`DeleteChildren attribute: Delete a child object by index`bool Delete(int index)`ClearChildren attribute: Empty the list`void Clear()`SelectAllChildren attribute: Create children for all objects that are compatible with link selection.`void SelectAll()`### Property

NameDescriptionSyntaxLinkedObjectsChildren attribute: Get linked objects`IReadOnlyCollection<SpaceClaim.Api.v261.IDocObject> LinkedObjects`CountChildren attribute: Get children count`int Count`ListChildren attribute: Get children collection`IReadOnlyCollection<SpeosDes.ControlPointConfiguration> List`ItemChildren attribute: Get child by index`SpeosDes.ControlPointConfiguration Item`## LightGuide.LightGuideLengthConfigurations

### Method

NameDescriptionSyntaxSetChildren attribute: Set from an array of script objects`bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)`SetChildren attribute: Set from an array of document objects`bool Set(SpaceClaim.Api.v261.IDocObject[] selectedObjects)`SetChildren attribute: Set from an array of objects (IDocObject type from unspecified version)`bool Set(System.Object[] docObjectsFromPreviousVersion)`GetEnumeratorChildren attribute: Get children enumeration`IEnumerator<SpeosDes.ControlPointConfiguration> GetEnumerator()`AddNewChildren attribute: Create a new child object`SpeosDes.ControlPointConfiguration AddNew(int insertIndex)`DeleteChildren attribute: Delete a child object by index`bool Delete(int index)`ClearChildren attribute: Empty the list`void Clear()`SelectAllChildren attribute: Create children for all objects that are compatible with link selection.`void SelectAll()`### Property

NameDescriptionSyntaxLinkedObjectsChildren attribute: Get linked objects`IReadOnlyCollection<SpaceClaim.Api.v261.IDocObject> LinkedObjects`CountChildren attribute: Get children count`int Count`ListChildren attribute: Get children collection`IReadOnlyCollection<SpeosDes.ControlPointConfiguration> List`ItemChildren attribute: Get child by index`SpeosDes.ControlPointConfiguration Item`## LightGuide.LightGuideTrimmingRatioConfigurations

### Method

NameDescriptionSyntaxSetChildren attribute: Set from an array of script objects`bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)`SetChildren attribute: Set from an array of document objects`bool Set(SpaceClaim.Api.v261.IDocObject[] selectedObjects)`SetChildren attribute: Set from an array of objects (IDocObject type from unspecified version)`bool Set(System.Object[] docObjectsFromPreviousVersion)`GetEnumeratorChildren attribute: Get children enumeration`IEnumerator<SpeosDes.ControlPointConfiguration> GetEnumerator()`AddNewChildren attribute: Create a new child object`SpeosDes.ControlPointConfiguration AddNew(int insertIndex)`DeleteChildren attribute: Delete a child object by index`bool Delete(int index)`ClearChildren attribute: Empty the list`void Clear()`SelectAllChildren attribute: Create children for all objects that are compatible with link selection.`void SelectAll()`### Property

NameDescriptionSyntaxLinkedObjectsChildren attribute: Get linked objects`IReadOnlyCollection<SpaceClaim.Api.v261.IDocObject> LinkedObjects`CountChildren attribute: Get children count`int Count`ListChildren attribute: Get children collection`IReadOnlyCollection<SpeosDes.ControlPointConfiguration> List`ItemChildren attribute: Get child by index`SpeosDes.ControlPointConfiguration Item`## LightGuide.LightGuidePeakTrimmingRatioConfigurations

### Method

NameDescriptionSyntaxSetChildren attribute: Set from an array of script objects`bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)`SetChildren attribute: Set from an array of document objects`bool Set(SpaceClaim.Api.v261.IDocObject[] selectedObjects)`SetChildren attribute: Set from an array of objects (IDocObject type from unspecified version)`bool Set(System.Object[] docObjectsFromPreviousVersion)`GetEnumeratorChildren attribute: Get children enumeration`IEnumerator<SpeosDes.ControlPointConfiguration> GetEnumerator()`AddNewChildren attribute: Create a new child object`SpeosDes.ControlPointConfiguration AddNew(int insertIndex)`DeleteChildren attribute: Delete a child object by index`bool Delete(int index)`ClearChildren attribute: Empty the list`void Clear()`SelectAllChildren attribute: Create children for all objects that are compatible with link selection.`void SelectAll()`### Property

NameDescriptionSyntaxLinkedObjectsChildren attribute: Get linked objects`IReadOnlyCollection<SpaceClaim.Api.v261.IDocObject> LinkedObjects`CountChildren attribute: Get children count`int Count`ListChildren attribute: Get children collection`IReadOnlyCollection<SpeosDes.ControlPointConfiguration> List`ItemChildren attribute: Get child by index`SpeosDes.ControlPointConfiguration Item`## LightGuide.LightGuideOffsetConfigurations

### Method

NameDescriptionSyntaxSetChildren attribute: Set from an array of script objects`bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)`SetChildren attribute: Set from an array of document objects`bool Set(SpaceClaim.Api.v261.IDocObject[] selectedObjects)`SetChildren attribute: Set from an array of objects (IDocObject type from unspecified version)`bool Set(System.Object[] docObjectsFromPreviousVersion)`GetEnumeratorChildren attribute: Get children enumeration`IEnumerator<SpeosDes.ControlPointConfiguration> GetEnumerator()`AddNewChildren attribute: Create a new child object`SpeosDes.ControlPointConfiguration AddNew(int insertIndex)`DeleteChildren attribute: Delete a child object by index`bool Delete(int index)`ClearChildren attribute: Empty the list`void Clear()`SelectAllChildren attribute: Create children for all objects that are compatible with link selection.`void SelectAll()`### Property

NameDescriptionSyntaxLinkedObjectsChildren attribute: Get linked objects`IReadOnlyCollection<SpaceClaim.Api.v261.IDocObject> LinkedObjects`CountChildren attribute: Get children count`int Count`ListChildren attribute: Get children collection`IReadOnlyCollection<SpeosDes.ControlPointConfiguration> List`ItemChildren attribute: Get child by index`SpeosDes.ControlPointConfiguration Item`## LightGuide.LightGuideWidthConfigurations

### Method

NameDescriptionSyntaxSetChildren attribute: Set from an array of script objects`bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)`SetChildren attribute: Set from an array of document objects`bool Set(SpaceClaim.Api.v261.IDocObject[] selectedObjects)`SetChildren attribute: Set from an array of objects (IDocObject type from unspecified version)`bool Set(System.Object[] docObjectsFromPreviousVersion)`GetEnumeratorChildren attribute: Get children enumeration`IEnumerator<SpeosDes.ControlPointConfiguration> GetEnumerator()`AddNewChildren attribute: Create a new child object`SpeosDes.ControlPointConfiguration AddNew(int insertIndex)`DeleteChildren attribute: Delete a child object by index`bool Delete(int index)`ClearChildren attribute: Empty the list`void Clear()`SelectAllChildren attribute: Create children for all objects that are compatible with link selection.`void SelectAll()`### Property

NameDescriptionSyntaxLinkedObjectsChildren attribute: Get linked objects`IReadOnlyCollection<SpaceClaim.Api.v261.IDocObject> LinkedObjects`CountChildren attribute: Get children count`int Count`ListChildren attribute: Get children collection`IReadOnlyCollection<SpeosDes.ControlPointConfiguration> List`ItemChildren attribute: Get child by index`SpeosDes.ControlPointConfiguration Item`## LightGuide.LightGuideStartAngleConfigurations

### Method

NameDescriptionSyntaxSetChildren attribute: Set from an array of script objects`bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)`SetChildren attribute: Set from an array of document objects`bool Set(SpaceClaim.Api.v261.IDocObject[] selectedObjects)`SetChildren attribute: Set from an array of objects (IDocObject type from unspecified version)`bool Set(System.Object[] docObjectsFromPreviousVersion)`GetEnumeratorChildren attribute: Get children enumeration`IEnumerator<SpeosDes.ControlPointConfiguration> GetEnumerator()`AddNewChildren attribute: Create a new child object`SpeosDes.ControlPointConfiguration AddNew(int insertIndex)`DeleteChildren attribute: Delete a child object by index`bool Delete(int index)`ClearChildren attribute: Empty the list`void Clear()`SelectAllChildren attribute: Create children for all objects that are compatible with link selection.`void SelectAll()`### Property

NameDescriptionSyntaxLinkedObjectsChildren attribute: Get linked objects`IReadOnlyCollection<SpaceClaim.Api.v261.IDocObject> LinkedObjects`CountChildren attribute: Get children count`int Count`ListChildren attribute: Get children collection`IReadOnlyCollection<SpeosDes.ControlPointConfiguration> List`ItemChildren attribute: Get child by index`SpeosDes.ControlPointConfiguration Item`## LightGuide.LightGuideEndAngleConfigurations

### Method

NameDescriptionSyntaxSetChildren attribute: Set from an array of script objects`bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)`SetChildren attribute: Set from an array of document objects`bool Set(SpaceClaim.Api.v261.IDocObject[] selectedObjects)`SetChildren attribute: Set from an array of objects (IDocObject type from unspecified version)`bool Set(System.Object[] docObjectsFromPreviousVersion)`GetEnumeratorChildren attribute: Get children enumeration`IEnumerator<SpeosDes.ControlPointConfiguration> GetEnumerator()`AddNewChildren attribute: Create a new child object`SpeosDes.ControlPointConfiguration AddNew(int insertIndex)`DeleteChildren attribute: Delete a child object by index`bool Delete(int index)`ClearChildren attribute: Empty the list`void Clear()`SelectAllChildren attribute: Create children for all objects that are compatible with link selection.`void SelectAll()`### Property

NameDescriptionSyntaxLinkedObjectsChildren attribute: Get linked objects`IReadOnlyCollection<SpaceClaim.Api.v261.IDocObject> LinkedObjects`CountChildren attribute: Get children count`int Count`ListChildren attribute: Get children collection`IReadOnlyCollection<SpeosDes.ControlPointConfiguration> List`ItemChildren attribute: Get child by index`SpeosDes.ControlPointConfiguration Item`## LightGuide.LightGuideStartRadiusConfigurations

### Method

NameDescriptionSyntaxSetChildren attribute: Set from an array of script objects`bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)`SetChildren attribute: Set from an array of document objects`bool Set(SpaceClaim.Api.v261.IDocObject[] selectedObjects)`SetChildren attribute: Set from an array of objects (IDocObject type from unspecified version)`bool Set(System.Object[] docObjectsFromPreviousVersion)`GetEnumeratorChildren attribute: Get children enumeration`IEnumerator<SpeosDes.ControlPointConfiguration> GetEnumerator()`AddNewChildren attribute: Create a new child object`SpeosDes.ControlPointConfiguration AddNew(int insertIndex)`DeleteChildren attribute: Delete a child object by index`bool Delete(int index)`ClearChildren attribute: Empty the list`void Clear()`SelectAllChildren attribute: Create children for all objects that are compatible with link selection.`void SelectAll()`### Property

NameDescriptionSyntaxLinkedObjectsChildren attribute: Get linked objects`IReadOnlyCollection<SpaceClaim.Api.v261.IDocObject> LinkedObjects`CountChildren attribute: Get children count`int Count`ListChildren attribute: Get children collection`IReadOnlyCollection<SpeosDes.ControlPointConfiguration> List`ItemChildren attribute: Get child by index`SpeosDes.ControlPointConfiguration Item`## LightGuide.LightGuideEndRadiusConfigurations

### Method

NameDescriptionSyntaxSetChildren attribute: Set from an array of script objects`bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)`SetChildren attribute: Set from an array of document objects`bool Set(SpaceClaim.Api.v261.IDocObject[] selectedObjects)`SetChildren attribute: Set from an array of objects (IDocObject type from unspecified version)`bool Set(System.Object[] docObjectsFromPreviousVersion)`GetEnumeratorChildren attribute: Get children enumeration`IEnumerator<SpeosDes.ControlPointConfiguration> GetEnumerator()`AddNewChildren attribute: Create a new child object`SpeosDes.ControlPointConfiguration AddNew(int insertIndex)`DeleteChildren attribute: Delete a child object by index`bool Delete(int index)`ClearChildren attribute: Empty the list`void Clear()`SelectAllChildren attribute: Create children for all objects that are compatible with link selection.`void SelectAll()`### Property

NameDescriptionSyntaxLinkedObjectsChildren attribute: Get linked objects`IReadOnlyCollection<SpaceClaim.Api.v261.IDocObject> LinkedObjects`CountChildren attribute: Get children count`int Count`ListChildren attribute: Get children collection`IReadOnlyCollection<SpeosDes.ControlPointConfiguration> List`ItemChildren attribute: Get child by index`SpeosDes.ControlPointConfiguration Item`## LightGuide.LightGuideDemoldingOrientation

### Method

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

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed object`SpaceClaim.Api.v261.IDocObject LinkedObject`## LightGuide.LightGuidePrismHeightConfigurations

### Method

NameDescriptionSyntaxSetChildren attribute: Set from an array of script objects`bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)`SetChildren attribute: Set from an array of document objects`bool Set(SpaceClaim.Api.v261.IDocObject[] selectedObjects)`SetChildren attribute: Set from an array of objects (IDocObject type from unspecified version)`bool Set(System.Object[] docObjectsFromPreviousVersion)`GetEnumeratorChildren attribute: Get children enumeration`IEnumerator<SpeosDes.ControlPointConfiguration> GetEnumerator()`AddNewChildren attribute: Create a new child object`SpeosDes.ControlPointConfiguration AddNew(int insertIndex)`DeleteChildren attribute: Delete a child object by index`bool Delete(int index)`ClearChildren attribute: Empty the list`void Clear()`SelectAllChildren attribute: Create children for all objects that are compatible with link selection.`void SelectAll()`### Property

NameDescriptionSyntaxLinkedObjectsChildren attribute: Get linked objects`IReadOnlyCollection<SpaceClaim.Api.v261.IDocObject> LinkedObjects`CountChildren attribute: Get children count`int Count`ListChildren attribute: Get children collection`IReadOnlyCollection<SpeosDes.ControlPointConfiguration> List`ItemChildren attribute: Get child by index`SpeosDes.ControlPointConfiguration Item`## LightGuide.LightGuideMillingConfigurations

### Method

NameDescriptionSyntaxSetChildren attribute: Set from an array of script objects`bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)`SetChildren attribute: Set from an array of document objects`bool Set(SpaceClaim.Api.v261.IDocObject[] selectedObjects)`SetChildren attribute: Set from an array of objects (IDocObject type from unspecified version)`bool Set(System.Object[] docObjectsFromPreviousVersion)`GetEnumeratorChildren attribute: Get children enumeration`IEnumerator<SpeosDes.ControlPointConfiguration> GetEnumerator()`AddNewChildren attribute: Create a new child object`SpeosDes.ControlPointConfiguration AddNew(int insertIndex)`DeleteChildren attribute: Delete a child object by index`bool Delete(int index)`ClearChildren attribute: Empty the list`void Clear()`SelectAllChildren attribute: Create children for all objects that are compatible with link selection.`void SelectAll()`### Property

NameDescriptionSyntaxLinkedObjectsChildren attribute: Get linked objects`IReadOnlyCollection<SpaceClaim.Api.v261.IDocObject> LinkedObjects`CountChildren attribute: Get children count`int Count`ListChildren attribute: Get children collection`IReadOnlyCollection<SpeosDes.ControlPointConfiguration> List`ItemChildren attribute: Get child by index`SpeosDes.ControlPointConfiguration Item`## LightGuide.LightGuideBottomPrismMillingConfigurations

### Method

NameDescriptionSyntaxSetChildren attribute: Set from an array of script objects`bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)`SetChildren attribute: Set from an array of document objects`bool Set(SpaceClaim.Api.v261.IDocObject[] selectedObjects)`SetChildren attribute: Set from an array of objects (IDocObject type from unspecified version)`bool Set(System.Object[] docObjectsFromPreviousVersion)`GetEnumeratorChildren attribute: Get children enumeration`IEnumerator<SpeosDes.ControlPointConfiguration> GetEnumerator()`AddNewChildren attribute: Create a new child object`SpeosDes.ControlPointConfiguration AddNew(int insertIndex)`DeleteChildren attribute: Delete a child object by index`bool Delete(int index)`ClearChildren attribute: Empty the list`void Clear()`SelectAllChildren attribute: Create children for all objects that are compatible with link selection.`void SelectAll()`### Property

NameDescriptionSyntaxLinkedObjectsChildren attribute: Get linked objects`IReadOnlyCollection<SpaceClaim.Api.v261.IDocObject> LinkedObjects`CountChildren attribute: Get children count`int Count`ListChildren attribute: Get children collection`IReadOnlyCollection<SpeosDes.ControlPointConfiguration> List`ItemChildren attribute: Get child by index`SpeosDes.ControlPointConfiguration Item`## MOS

### Static method

NameDescriptionSyntaxFromSelectionConvert Items of a ScriptSelection to a list of Speos objects when their type is matching.`IEnumerable<SpeosDes.MOS> FromSelection(IEnumerable<SpaceClaim.Api.v261.IDocObject> 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 component`SpeosDes.MOS Create(object parent)`CreateCreate a new object in the active context`SpeosDes.MOS Create()`### Method

NameDescriptionSyntaxCloneCreate a copy of this object in the active context`SpeosDes.MOS Clone()`CopyToCreate a copy of this object and paste it to the specified destination`SpeosDes.MOS CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)`ExportAsCSVFile`void ExportAsCSVFile(string csvFilePath)`ExtractToolingPath`void ExtractToolingPath()`FindOccurrenceInActivePartSearch for occurrences of this object in the active Part`object FindOccurrenceInActivePart()`FindOccurrenceInContextOfSearch for occurrences of this object in the specified Part`SpaceClaim.Api.v261.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.v261.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 object`bool Delete()`GetChildSubjectsRetrieve all children as DocObjects`IEnumerable<SpaceClaim.Api.v261.CustomObject> GetChildSubjects()`GetChildrenRetrieve all direct children of a given type`IEnumerable<TSpecificApiType> GetChildren<TSpecificApiType>()`ComputeExecute the Compute command on the object`void Compute()`PublishParameterPublish or un-publish a number attribute as driving parameter`void 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 attribute`SpeosDes.MOS.MOSGuideCurve GuideCurve`ReverseGuideCurveDirectionBoolean attribute`bool ReverseGuideCurveDirection`SecondCurveLinks attribute`SpeosDes.MOS.MOSSecondCurve SecondCurve`ConstructionTypeEnum attribute`SpeosDes.MOS.EnumConstructionType ConstructionType`ConstructionTypeIndexEnum attribute (as index)`int ConstructionTypeIndex`OpticalAxisLink attribute`SpeosDes.MOS.MOSOpticalAxis OpticalAxis`ReverseOpticalAxisDirectionBoolean attribute`bool ReverseOpticalAxisDirection`SupportSurfaceLink attribute`SpeosDes.MOS.MOSSupportSurface SupportSurface`ProjectionTypeEnum attribute`SpeosDes.MOS.EnumProjectionType ProjectionType`ProjectionTypeIndexEnum attribute (as index)`int ProjectionTypeIndex`SupportSideEnum attribute`SpeosDes.MOS.EnumSupportSide SupportSide`SupportSideIndexEnum attribute (as index)`int SupportSideIndex`ThicknessNumber attribute`double Thickness`ThicknessTextNumber attribute (as text)`string ThicknessText`SideAngleNumber attribute`double SideAngle`SideAngleTextNumber attribute (as text)`string SideAngleText`RadiusNumber attribute`double Radius`RadiusTextNumber attribute (as text)`string RadiusText`ControlPointsChildren attribute`SpeosDes.MOS.MOSControlPoints ControlPoints`StripesCountNumber attribute`int StripesCount`StripesCountTextNumber attribute (as text)`string StripesCountText`DraftingAxisLink attribute`SpeosDes.MOS.MOSDraftingAxis DraftingAxis`ReverseDraftingAxisDirectionBoolean attribute`bool ReverseDraftingAxisDirection`DraftingAngleNumber attribute`double DraftingAngle`DraftingAngleTextNumber attribute (as text)`string DraftingAngleText`SubjectDeprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper`SpaceClaim.Api.v261.CustomObject Subject`OccurrenceGet the underlying CustomObject occurrence, associated to the API object wrapper in current API version`object Occurrence`NameGet or Set the name of the object`string Name`VisibleChange the visibility status (same behavior as checking/unchecking on the tree view item)`bool Visible`StatusInfoGet the status of the object (warning or error message)`string StatusInfo`IsUpToDateAsk if the object was modified since its last successful computation`bool IsUpToDate`## MOS.MOSGuideCurve

### Method

NameDescriptionSyntaxSetLinks attribute: Link to an array of script objects`bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)`SetLinks attribute: Link to an array of document objects`bool Set(SpaceClaim.Api.v261.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 links`void Clear()`SelectAllLinks attribute: Link to all compatible objects in the active context`void SelectAll()`### Property

NameDescriptionSyntaxLinkedObjectsLinks attribute: Get the pointed document objects`IReadOnlyCollection<SpaceClaim.Api.v261.IDocObject> LinkedObjects`ItemLinks attribute: Get a pointed document object by index`SpaceClaim.Api.v261.IDocObject Item`CountLinks attribute: Get the links count`int Count`## MOS.MOSSecondCurve

### Method

NameDescriptionSyntaxSetLinks attribute: Link to an array of script objects`bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)`SetLinks attribute: Link to an array of document objects`bool Set(SpaceClaim.Api.v261.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 links`void Clear()`SelectAllLinks attribute: Link to all compatible objects in the active context`void SelectAll()`### Property

NameDescriptionSyntaxLinkedObjectsLinks attribute: Get the pointed document objects`IReadOnlyCollection<SpaceClaim.Api.v261.IDocObject> LinkedObjects`ItemLinks attribute: Get a pointed document object by index`SpaceClaim.Api.v261.IDocObject Item`CountLinks attribute: Get the links count`int Count`## MOS.MOSOpticalAxis

### Method

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

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed object`SpaceClaim.Api.v261.IDocObject LinkedObject`## MOS.MOSSupportSurface

### Method

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

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed object`SpaceClaim.Api.v261.IDocObject LinkedObject`## MOS.MOSControlPoints

### Method

NameDescriptionSyntaxSetChildren attribute: Set from an array of script objects`bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)`SetChildren attribute: Set from an array of document objects`bool Set(SpaceClaim.Api.v261.IDocObject[] selectedObjects)`SetChildren attribute: Set from an array of objects (IDocObject type from unspecified version)`bool Set(System.Object[] docObjectsFromPreviousVersion)`GetEnumeratorChildren attribute: Get children enumeration`IEnumerator<SpeosDes.MOSControlPoint> GetEnumerator()`AddNewChildren attribute: Create a new child object`SpeosDes.MOSControlPoint AddNew(int insertIndex)`DeleteChildren attribute: Delete a child object by index`bool Delete(int index)`ClearChildren attribute: Empty the list`void Clear()`SelectAllChildren attribute: Create children for all objects that are compatible with link selection.`void SelectAll()`### Property

NameDescriptionSyntaxLinkedObjectsChildren attribute: Get linked objects`IReadOnlyCollection<SpaceClaim.Api.v261.IDocObject> LinkedObjects`CountChildren attribute: Get children count`int Count`ListChildren attribute: Get children collection`IReadOnlyCollection<SpeosDes.MOSControlPoint> List`ItemChildren attribute: Get child by index`SpeosDes.MOSControlPoint Item`## MOS.MOSDraftingAxis

### Method

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

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed object`SpaceClaim.Api.v261.IDocObject LinkedObject`## MOSControlPoint

### Static method

NameDescriptionSyntaxCreateCreate a new object of this type`SpeosDes.MOSControlPoint Create()`### Method

NameDescriptionSyntaxToString`string ToString()`### Property

NameDescriptionSyntaxPositionNumber attribute`double Position`PositionTextNumber attribute (as text)`string PositionText`DepthNumber attribute`double Depth`DepthTextNumber attribute (as text)`string DepthText`PitchNumber attribute`double Pitch`PitchTextNumber attribute (as text)`string PitchText`TopLengthNumber attribute`double TopLength`TopLengthTextNumber attribute (as text)`string TopLengthText`BitShapeStartAngleNumber attribute`double BitShapeStartAngle`BitShapeStartAngleTextNumber attribute (as text)`string BitShapeStartAngleText`BitShapeEndAngleNumber attribute`double BitShapeEndAngle`BitShapeEndAngleTextNumber attribute (as text)`string BitShapeEndAngleText`## MultipleOpticalAxis

### Static method

NameDescriptionSyntaxCreateCreate a new object of this type`SpeosDes.MultipleOpticalAxis Create()`### Method

NameDescriptionSyntaxToString`string ToString()`### Property

NameDescriptionSyntaxPositionNumber attribute`double Position`PositionTextNumber attribute (as text)`string PositionText`OpticalAxisLink attribute`SpeosDes.MultipleOpticalAxis.MultipleOpticalAxisOpticalAxis OpticalAxis`ReverseDirectionBoolean attribute`bool ReverseDirection`## MultipleOpticalAxis.MultipleOpticalAxisOpticalAxis

### Method

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

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed object`SpaceClaim.Api.v261.IDocObject LinkedObject`## Node

### Static method

NameDescriptionSyntaxFromSelectionConvert Items of a ScriptSelection to a list of Speos objects when their type is matching.`IEnumerable<SpeosDes.Node> FromSelection(IEnumerable<SpaceClaim.Api.v261.IDocObject> 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 component`SpeosDes.Node Create(object parent)`CreateCreate a new object in the active context`SpeosDes.Node Create()`### Method

NameDescriptionSyntaxCloneCreate a copy of this object in the active context`SpeosDes.Node Clone()`CopyToCreate a copy of this object and paste it to the specified destination`SpeosDes.Node CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)`FindOccurrenceInActivePartSearch for occurrences of this object in the active Part`object FindOccurrenceInActivePart()`FindOccurrenceInContextOfSearch for occurrences of this object in the specified Part`SpaceClaim.Api.v261.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.v261.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 object`bool Delete()`GetChildSubjectsRetrieve all children as DocObjects`IEnumerable<SpaceClaim.Api.v261.CustomObject> GetChildSubjects()`GetChildrenRetrieve all direct children of a given type`IEnumerable<TSpecificApiType> GetChildren<TSpecificApiType>()`ComputeExecute the Compute command on the object`void Compute()`PublishParameterPublish or un-publish a number attribute as driving parameter`void 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 wrapper`SpaceClaim.Api.v261.CustomObject Subject`OccurrenceGet the underlying CustomObject occurrence, associated to the API object wrapper in current API version`object Occurrence`NameGet or Set the name of the object`string Name`VisibleChange the visibility status (same behavior as checking/unchecking on the tree view item)`bool Visible`StatusInfoGet the status of the object (warning or error message)`string StatusInfo`IsUpToDateAsk if the object was modified since its last successful computation`bool IsUpToDate`## OpticalFeatureGeneral

### Static method

NameDescriptionSyntaxFromSelectionConvert Items of a ScriptSelection to a list of Speos objects when their type is matching.`IEnumerable<SpeosDes.OpticalFeatureGeneral> FromSelection(IEnumerable<SpaceClaim.Api.v261.IDocObject> 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 values`IEnumerable<string> GetSourceTypePossibleValues()`FindOccurrenceInActivePartSearch for occurrences of this object in the active Part`object FindOccurrenceInActivePart()`FindOccurrenceInContextOfSearch for occurrences of this object in the specified Part`SpaceClaim.Api.v261.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.v261.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 object`bool Delete()`GetChildSubjectsRetrieve all children as DocObjects`IEnumerable<SpaceClaim.Api.v261.CustomObject> GetChildSubjects()`GetChildrenRetrieve all direct children of a given type`IEnumerable<TSpecificApiType> GetChildren<TSpecificApiType>()`ComputeExecute the Compute command on the object`void Compute()`PublishParameterPublish or un-publish a number attribute as driving parameter`void 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 attribute`string SourceType`SourcePointLink attribute`SpeosDes.OpticalFeatureGeneral.OpticalFeatureGeneralSourcePoint SourcePoint`SourceBodyLink attribute`SpeosDes.OpticalFeatureGeneral.OpticalFeatureGeneralSourceBody SourceBody`SourceDirectionLink attribute`SpeosDes.OpticalFeatureGeneral.OpticalFeatureGeneralSourceDirection SourceDirection`ReverseSourceDirectionBoolean attribute`bool ReverseSourceDirection`SourceRefractiveIndexNumber attribute`double SourceRefractiveIndex`SourceRefractiveIndexTextNumber attribute (as text)`string SourceRefractiveIndexText`SourceFluxNumber attribute`double SourceFlux`SourceFluxTextNumber attribute (as text)`string SourceFluxText`SupportTypeEnum attribute`SpeosDes.OpticalFeatureGeneral.EnumSupportType SupportType`SupportTypeIndexEnum attribute (as index)`int SupportTypeIndex`SupportBodyLink attribute`SpeosDes.OpticalFeatureGeneral.OpticalFeatureGeneralSupportBody SupportBody`SupportOriginLink attribute`SpeosDes.OpticalFeatureGeneral.OpticalFeatureGeneralSupportOrigin SupportOrigin`SupportAxisLink attribute`SpeosDes.OpticalFeatureGeneral.OpticalFeatureGeneralSupportAxis SupportAxis`ReverseSupportAxisBoolean attribute`bool ReverseSupportAxis`SupportOrientationLink attribute`SpeosDes.OpticalFeatureGeneral.OpticalFeatureGeneralSupportOrientation SupportOrientation`ReverseSupportOrientationBoolean attribute`bool ReverseSupportOrientation`SupportOrientationTypeEnum attribute`SpeosDes.OpticalFeatureGeneral.EnumSupportOrientationType SupportOrientationType`SupportOrientationTypeIndexEnum attribute (as index)`int SupportOrientationTypeIndex`ThicknessNumber attribute`double Thickness`ThicknessTextNumber attribute (as text)`string ThicknessText`RefractiveIndexNumber attribute`double RefractiveIndex`RefractiveIndexTextNumber attribute (as text)`string RefractiveIndexText`TargetTypeEnum attribute`SpeosDes.OpticalFeatureGeneral.EnumTargetType TargetType`TargetTypeIndexEnum attribute (as index)`int TargetTypeIndex`IntegrationDirectionIsReversedBoolean attribute`bool IntegrationDirectionIsReversed`XMPTemplateFileFile attribute`string XMPTemplateFile`XMPTemplateFileFullPathFile attribute (absolute full path)`string XMPTemplateFileFullPath`TargetOriginLink attribute`SpeosDes.OpticalFeatureGeneral.OpticalFeatureGeneralTargetOrigin TargetOrigin`TargetAxisLink attribute`SpeosDes.OpticalFeatureGeneral.OpticalFeatureGeneralTargetAxis TargetAxis`ReverseTargetAxisBoolean attribute`bool ReverseTargetAxis`TargetOrientationLink attribute`SpeosDes.OpticalFeatureGeneral.OpticalFeatureGeneralTargetOrientation TargetOrientation`ReverseTargetOrientationBoolean attribute`bool ReverseTargetOrientation`ResultViewingDirectionEnum attribute`SpeosDes.OpticalFeatureGeneral.EnumResultViewingDirection ResultViewingDirection`ResultViewingDirectionIndexEnum attribute (as index)`int ResultViewingDirectionIndex`ContourSurfacesLinks attribute`SpeosDes.OpticalFeatureGeneral.OpticalFeatureGeneralContourSurfaces ContourSurfaces`SurfacePointToKeepNullable point attribute`Point? SurfacePointToKeep`SubjectDeprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper`SpaceClaim.Api.v261.CustomObject Subject`OccurrenceGet the underlying CustomObject occurrence, associated to the API object wrapper in current API version`object Occurrence`NameGet or Set the name of the object`string Name`VisibleChange the visibility status (same behavior as checking/unchecking on the tree view item)`bool Visible`StatusInfoGet the status of the object (warning or error message)`string StatusInfo`IsUpToDateAsk if the object was modified since its last successful computation`bool IsUpToDate`## OpticalFeatureGeneral.OpticalFeatureGeneralSourcePoint

### Method

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

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed object`SpaceClaim.Api.v261.IDocObject LinkedObject`## OpticalFeatureGeneral.OpticalFeatureGeneralSourceBody

### Method

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

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed object`SpaceClaim.Api.v261.IDocObject LinkedObject`## OpticalFeatureGeneral.OpticalFeatureGeneralSourceDirection

### Method

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

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed object`SpaceClaim.Api.v261.IDocObject LinkedObject`## OpticalFeatureGeneral.OpticalFeatureGeneralSupportBody

### Method

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

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed object`SpaceClaim.Api.v261.IDocObject LinkedObject`## OpticalFeatureGeneral.OpticalFeatureGeneralSupportOrigin

### Method

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

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed object`SpaceClaim.Api.v261.IDocObject LinkedObject`## OpticalFeatureGeneral.OpticalFeatureGeneralSupportAxis

### Method

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

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed object`SpaceClaim.Api.v261.IDocObject LinkedObject`## OpticalFeatureGeneral.OpticalFeatureGeneralSupportOrientation

### Method

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

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed object`SpaceClaim.Api.v261.IDocObject LinkedObject`## OpticalFeatureGeneral.OpticalFeatureGeneralTargetOrigin

### Method

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

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed object`SpaceClaim.Api.v261.IDocObject LinkedObject`## OpticalFeatureGeneral.OpticalFeatureGeneralTargetAxis

### Method

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

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed object`SpaceClaim.Api.v261.IDocObject LinkedObject`## OpticalFeatureGeneral.OpticalFeatureGeneralTargetOrientation

### Method

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

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed object`SpaceClaim.Api.v261.IDocObject LinkedObject`## OpticalFeatureGeneral.OpticalFeatureGeneralContourSurfaces

### Method

NameDescriptionSyntaxSetLinks attribute: Link to an array of script objects`bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)`SetLinks attribute: Link to an array of document objects`bool Set(SpaceClaim.Api.v261.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 links`void Clear()`SelectAllLinks attribute: Link to all compatible objects in the active context`void SelectAll()`### Property

NameDescriptionSyntaxLinkedObjectsLinks attribute: Get the pointed document objects`IReadOnlyCollection<SpaceClaim.Api.v261.IDocObject> LinkedObjects`ItemLinks attribute: Get a pointed document object by index`SpaceClaim.Api.v261.IDocObject Item`CountLinks attribute: Get the links count`int Count`## OpticalFeatureManufacturing

### Static method

NameDescriptionSyntaxFromSelectionConvert Items of a ScriptSelection to a list of Speos objects when their type is matching.`IEnumerable<SpeosDes.OpticalFeatureManufacturing> FromSelection(IEnumerable<SpaceClaim.Api.v261.IDocObject> 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 values`IEnumerable<string> GetDraftingTypePossibleValues()`FindOccurrenceInActivePartSearch for occurrences of this object in the active Part`object FindOccurrenceInActivePart()`FindOccurrenceInContextOfSearch for occurrences of this object in the specified Part`SpaceClaim.Api.v261.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.v261.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 object`bool Delete()`GetChildSubjectsRetrieve all children as DocObjects`IEnumerable<SpaceClaim.Api.v261.CustomObject> GetChildSubjects()`GetChildrenRetrieve all direct children of a given type`IEnumerable<TSpecificApiType> GetChildren<TSpecificApiType>()`ComputeExecute the Compute command on the object`void Compute()`PublishParameterPublish or un-publish a number attribute as driving parameter`void 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 attribute`bool Sewing`DraftingTypeString list selection attribute`string DraftingType`DraftValueNumber attribute`double DraftValue`DraftValueTextNumber attribute (as text)`string DraftValueText`DraftAllBoolean attribute`bool DraftAll`AngularDraftValueNumber attribute`double AngularDraftValue`AngularDraftValueTextNumber attribute (as text)`string AngularDraftValueText`SubjectDeprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper`SpaceClaim.Api.v261.CustomObject Subject`OccurrenceGet the underlying CustomObject occurrence, associated to the API object wrapper in current API version`object Occurrence`NameGet or Set the name of the object`string Name`VisibleChange the visibility status (same behavior as checking/unchecking on the tree view item)`bool Visible`StatusInfoGet the status of the object (warning or error message)`string StatusInfo`IsUpToDateAsk if the object was modified since its last successful computation`bool IsUpToDate`## OpticalFeatureStyleCircular

### Static method

NameDescriptionSyntaxFromSelectionConvert Items of a ScriptSelection to a list of Speos objects when their type is matching.`IEnumerable<SpeosDes.OpticalFeatureStyleCircular> FromSelection(IEnumerable<SpaceClaim.Api.v261.IDocObject> 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 Part`object FindOccurrenceInActivePart()`FindOccurrenceInContextOfSearch for occurrences of this object in the specified Part`SpaceClaim.Api.v261.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.v261.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 object`bool Delete()`GetChildSubjectsRetrieve all children as DocObjects`IEnumerable<SpaceClaim.Api.v261.CustomObject> GetChildSubjects()`GetChildrenRetrieve all direct children of a given type`IEnumerable<TSpecificApiType> GetChildren<TSpecificApiType>()`ComputeExecute the Compute command on the object`void Compute()`PublishParameterPublish or un-publish a number attribute as driving parameter`void 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 attribute`double Start`StartTextNumber attribute (as text)`string StartText`EndNumber attribute`double End`EndTextNumber attribute (as text)`string EndText`StepNumber attribute`double Step`StepTextNumber attribute (as text)`string StepText`ShiftTypeEnum attribute`SpeosDes.OpticalFeatureStyleCircular.EnumShiftType ShiftType`ShiftTypeIndexEnum attribute (as index)`int ShiftTypeIndex`ShiftLengthNumber attribute`double ShiftLength`ShiftLengthTextNumber attribute (as text)`string ShiftLengthText`ShiftAngleNumber attribute`double ShiftAngle`ShiftAngleTextNumber attribute (as text)`string ShiftAngleText`DefinitionEnum attribute`SpeosDes.OpticalFeatureStyleCircular.EnumDefinition Definition`DefinitionIndexEnum attribute (as index)`int DefinitionIndex`SectorsNumber attribute`int Sectors`SectorsTextNumber attribute (as text)`string SectorsText`AngleNumber attribute`double Angle`AngleTextNumber attribute (as text)`string AngleText`CircularEdgesBoolean attribute`bool CircularEdges`StyleOriginLink attribute`SpeosDes.OpticalFeatureStyleCircular.OpticalFeatureStyleCircularStyleOrigin StyleOrigin`StyleAxisLink attribute`SpeosDes.OpticalFeatureStyleCircular.OpticalFeatureStyleCircularStyleAxis StyleAxis`ReverseStyleAxisBoolean attribute`bool ReverseStyleAxis`StyleOrientationLink attribute`SpeosDes.OpticalFeatureStyleCircular.OpticalFeatureStyleCircularStyleOrientation StyleOrientation`ReverseStyleOrientationBoolean attribute`bool ReverseStyleOrientation`SubjectDeprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper`SpaceClaim.Api.v261.CustomObject Subject`OccurrenceGet the underlying CustomObject occurrence, associated to the API object wrapper in current API version`object Occurrence`NameGet or Set the name of the object`string Name`VisibleChange the visibility status (same behavior as checking/unchecking on the tree view item)`bool Visible`StatusInfoGet the status of the object (warning or error message)`string StatusInfo`IsUpToDateAsk if the object was modified since its last successful computation`bool IsUpToDate`## OpticalFeatureStyleCircular.OpticalFeatureStyleCircularStyleOrigin

### Method

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

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed object`SpaceClaim.Api.v261.IDocObject LinkedObject`## OpticalFeatureStyleCircular.OpticalFeatureStyleCircularStyleAxis

### Method

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

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed object`SpaceClaim.Api.v261.IDocObject LinkedObject`## OpticalFeatureStyleCircular.OpticalFeatureStyleCircularStyleOrientation

### Method

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

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed object`SpaceClaim.Api.v261.IDocObject LinkedObject`## OpticalFeatureStyleFreestyle

### Static method

NameDescriptionSyntaxFromSelectionConvert Items of a ScriptSelection to a list of Speos objects when their type is matching.`IEnumerable<SpeosDes.OpticalFeatureStyleFreestyle> FromSelection(IEnumerable<SpaceClaim.Api.v261.IDocObject> 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 Part`object FindOccurrenceInActivePart()`FindOccurrenceInContextOfSearch for occurrences of this object in the specified Part`SpaceClaim.Api.v261.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.v261.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 object`bool Delete()`GetChildSubjectsRetrieve all children as DocObjects`IEnumerable<SpaceClaim.Api.v261.CustomObject> GetChildSubjects()`GetChildrenRetrieve all direct children of a given type`IEnumerable<TSpecificApiType> GetChildren<TSpecificApiType>()`ComputeExecute the Compute command on the object`void Compute()`PublishParameterPublish or un-publish a number attribute as driving parameter`void 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 attribute`SpeosDes.OpticalFeatureStyleFreestyle.OpticalFeatureStyleFreestyleXCurves XCurves`YCurvesLinks attribute`SpeosDes.OpticalFeatureStyleFreestyle.OpticalFeatureStyleFreestyleYCurves YCurves`StyleOriginLink attribute`SpeosDes.OpticalFeatureStyleFreestyle.OpticalFeatureStyleFreestyleStyleOrigin StyleOrigin`StyleAxisLink attribute`SpeosDes.OpticalFeatureStyleFreestyle.OpticalFeatureStyleFreestyleStyleAxis StyleAxis`ReverseStyleAxisBoolean attribute`bool ReverseStyleAxis`StyleOrientationLink attribute`SpeosDes.OpticalFeatureStyleFreestyle.OpticalFeatureStyleFreestyleStyleOrientation StyleOrientation`ReverseStyleOrientationBoolean attribute`bool ReverseStyleOrientation`SubjectDeprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper`SpaceClaim.Api.v261.CustomObject Subject`OccurrenceGet the underlying CustomObject occurrence, associated to the API object wrapper in current API version`object Occurrence`NameGet or Set the name of the object`string Name`VisibleChange the visibility status (same behavior as checking/unchecking on the tree view item)`bool Visible`StatusInfoGet the status of the object (warning or error message)`string StatusInfo`IsUpToDateAsk if the object was modified since its last successful computation`bool IsUpToDate`## OpticalFeatureStyleFreestyle.OpticalFeatureStyleFreestyleXCurves

### Method

NameDescriptionSyntaxSetLinks attribute: Link to an array of script objects`bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)`SetLinks attribute: Link to an array of document objects`bool Set(SpaceClaim.Api.v261.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 links`void Clear()`SelectAllLinks attribute: Link to all compatible objects in the active context`void SelectAll()`### Property

NameDescriptionSyntaxLinkedObjectsLinks attribute: Get the pointed document objects`IReadOnlyCollection<SpaceClaim.Api.v261.IDocObject> LinkedObjects`ItemLinks attribute: Get a pointed document object by index`SpaceClaim.Api.v261.IDocObject Item`CountLinks attribute: Get the links count`int Count`## OpticalFeatureStyleFreestyle.OpticalFeatureStyleFreestyleYCurves

### Method

NameDescriptionSyntaxSetLinks attribute: Link to an array of script objects`bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)`SetLinks attribute: Link to an array of document objects`bool Set(SpaceClaim.Api.v261.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 links`void Clear()`SelectAllLinks attribute: Link to all compatible objects in the active context`void SelectAll()`### Property

NameDescriptionSyntaxLinkedObjectsLinks attribute: Get the pointed document objects`IReadOnlyCollection<SpaceClaim.Api.v261.IDocObject> LinkedObjects`ItemLinks attribute: Get a pointed document object by index`SpaceClaim.Api.v261.IDocObject Item`CountLinks attribute: Get the links count`int Count`## OpticalFeatureStyleFreestyle.OpticalFeatureStyleFreestyleStyleOrigin

### Method

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

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed object`SpaceClaim.Api.v261.IDocObject LinkedObject`## OpticalFeatureStyleFreestyle.OpticalFeatureStyleFreestyleStyleAxis

### Method

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

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed object`SpaceClaim.Api.v261.IDocObject LinkedObject`## OpticalFeatureStyleFreestyle.OpticalFeatureStyleFreestyleStyleOrientation

### Method

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

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed object`SpaceClaim.Api.v261.IDocObject LinkedObject`## OpticalFeatureStyleHoneycomb

### Static method

NameDescriptionSyntaxFromSelectionConvert Items of a ScriptSelection to a list of Speos objects when their type is matching.`IEnumerable<SpeosDes.OpticalFeatureStyleHoneycomb> FromSelection(IEnumerable<SpaceClaim.Api.v261.IDocObject> 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 Part`object FindOccurrenceInActivePart()`FindOccurrenceInContextOfSearch for occurrences of this object in the specified Part`SpaceClaim.Api.v261.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.v261.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 object`bool Delete()`GetChildSubjectsRetrieve all children as DocObjects`IEnumerable<SpaceClaim.Api.v261.CustomObject> GetChildSubjects()`GetChildrenRetrieve all direct children of a given type`IEnumerable<TSpecificApiType> GetChildren<TSpecificApiType>()`ComputeExecute the Compute command on the object`void Compute()`PublishParameterPublish or un-publish a number attribute as driving parameter`void 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 attribute`double XStart`XStartTextNumber attribute (as text)`string XStartText`XEndNumber attribute`double XEnd`XEndTextNumber attribute (as text)`string XEndText`YStartNumber attribute`double YStart`YStartTextNumber attribute (as text)`string YStartText`YEndNumber attribute`double YEnd`YEndTextNumber attribute (as text)`string YEndText`RotationNumber attribute`double Rotation`RotationTextNumber attribute (as text)`string RotationText`DefinitionEnum attribute`SpeosDes.OpticalFeatureStyleHoneycomb.EnumDefinition Definition`DefinitionIndexEnum attribute (as index)`int DefinitionIndex`SideLengthNumber attribute`double SideLength`SideLengthTextNumber attribute (as text)`string SideLengthText`WidthNumber attribute`double Width`WidthTextNumber attribute (as text)`string WidthText`StyleOriginLink attribute`SpeosDes.OpticalFeatureStyleHoneycomb.OpticalFeatureStyleHoneycombStyleOrigin StyleOrigin`StyleAxisLink attribute`SpeosDes.OpticalFeatureStyleHoneycomb.OpticalFeatureStyleHoneycombStyleAxis StyleAxis`ReverseStyleAxisBoolean attribute`bool ReverseStyleAxis`StyleOrientationLink attribute`SpeosDes.OpticalFeatureStyleHoneycomb.OpticalFeatureStyleHoneycombStyleOrientation StyleOrientation`ReverseStyleOrientationBoolean attribute`bool ReverseStyleOrientation`SubjectDeprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper`SpaceClaim.Api.v261.CustomObject Subject`OccurrenceGet the underlying CustomObject occurrence, associated to the API object wrapper in current API version`object Occurrence`NameGet or Set the name of the object`string Name`VisibleChange the visibility status (same behavior as checking/unchecking on the tree view item)`bool Visible`StatusInfoGet the status of the object (warning or error message)`string StatusInfo`IsUpToDateAsk if the object was modified since its last successful computation`bool IsUpToDate`## OpticalFeatureStyleHoneycomb.OpticalFeatureStyleHoneycombStyleOrigin

### Method

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

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed object`SpaceClaim.Api.v261.IDocObject LinkedObject`## OpticalFeatureStyleHoneycomb.OpticalFeatureStyleHoneycombStyleAxis

### Method

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

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed object`SpaceClaim.Api.v261.IDocObject LinkedObject`## OpticalFeatureStyleHoneycomb.OpticalFeatureStyleHoneycombStyleOrientation

### Method

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

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed object`SpaceClaim.Api.v261.IDocObject LinkedObject`## OpticalFeatureStyleRectangular

### Static method

NameDescriptionSyntaxFromSelectionConvert Items of a ScriptSelection to a list of Speos objects when their type is matching.`IEnumerable<SpeosDes.OpticalFeatureStyleRectangular> FromSelection(IEnumerable<SpaceClaim.Api.v261.IDocObject> 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 Part`object FindOccurrenceInActivePart()`FindOccurrenceInContextOfSearch for occurrences of this object in the specified Part`SpaceClaim.Api.v261.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.v261.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 object`bool Delete()`GetChildSubjectsRetrieve all children as DocObjects`IEnumerable<SpaceClaim.Api.v261.CustomObject> GetChildSubjects()`GetChildrenRetrieve all direct children of a given type`IEnumerable<TSpecificApiType> GetChildren<TSpecificApiType>()`ComputeExecute the Compute command on the object`void Compute()`PublishParameterPublish or un-publish a number attribute as driving parameter`void 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 attribute`double XStart`XStartTextNumber attribute (as text)`string XStartText`XEndNumber attribute`double XEnd`XEndTextNumber attribute (as text)`string XEndText`YStartNumber attribute`double YStart`YStartTextNumber attribute (as text)`string YStartText`YEndNumber attribute`double YEnd`YEndTextNumber attribute (as text)`string YEndText`XAngleNumber attribute`double XAngle`XAngleTextNumber attribute (as text)`string XAngleText`YAngleNumber attribute`double YAngle`YAngleTextNumber attribute (as text)`string YAngleText`DefinitionEnum attribute`SpeosDes.OpticalFeatureStyleRectangular.EnumDefinition Definition`DefinitionIndexEnum attribute (as index)`int DefinitionIndex`XCountNumber attribute`int XCount`XCountTextNumber attribute (as text)`string XCountText`YCountNumber attribute`int YCount`YCountTextNumber attribute (as text)`string YCountText`XSizeNumber attribute`double XSize`XSizeTextNumber attribute (as text)`string XSizeText`YSizeNumber attribute`double YSize`YSizeTextNumber attribute (as text)`string YSizeText`StyleOriginLink attribute`SpeosDes.OpticalFeatureStyleRectangular.OpticalFeatureStyleRectangularStyleOrigin StyleOrigin`StyleAxisLink attribute`SpeosDes.OpticalFeatureStyleRectangular.OpticalFeatureStyleRectangularStyleAxis StyleAxis`ReverseStyleAxisBoolean attribute`bool ReverseStyleAxis`StyleOrientationLink attribute`SpeosDes.OpticalFeatureStyleRectangular.OpticalFeatureStyleRectangularStyleOrientation StyleOrientation`ReverseStyleOrientationBoolean attribute`bool ReverseStyleOrientation`SubjectDeprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper`SpaceClaim.Api.v261.CustomObject Subject`OccurrenceGet the underlying CustomObject occurrence, associated to the API object wrapper in current API version`object Occurrence`NameGet or Set the name of the object`string Name`VisibleChange the visibility status (same behavior as checking/unchecking on the tree view item)`bool Visible`StatusInfoGet the status of the object (warning or error message)`string StatusInfo`IsUpToDateAsk if the object was modified since its last successful computation`bool IsUpToDate`## OpticalFeatureStyleRectangular.OpticalFeatureStyleRectangularStyleOrigin

### Method

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

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed object`SpaceClaim.Api.v261.IDocObject LinkedObject`## OpticalFeatureStyleRectangular.OpticalFeatureStyleRectangularStyleAxis

### Method

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

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed object`SpaceClaim.Api.v261.IDocObject LinkedObject`## OpticalFeatureStyleRectangular.OpticalFeatureStyleRectangularStyleOrientation

### Method

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

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed object`SpaceClaim.Api.v261.IDocObject LinkedObject`## OpticalFeatureStyleStripes

### Static method

NameDescriptionSyntaxFromSelectionConvert Items of a ScriptSelection to a list of Speos objects when their type is matching.`IEnumerable<SpeosDes.OpticalFeatureStyleStripes> FromSelection(IEnumerable<SpaceClaim.Api.v261.IDocObject> 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 Part`object FindOccurrenceInActivePart()`FindOccurrenceInContextOfSearch for occurrences of this object in the specified Part`SpaceClaim.Api.v261.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.v261.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 object`bool Delete()`GetChildSubjectsRetrieve all children as DocObjects`IEnumerable<SpaceClaim.Api.v261.CustomObject> GetChildSubjects()`GetChildrenRetrieve all direct children of a given type`IEnumerable<TSpecificApiType> GetChildren<TSpecificApiType>()`ComputeExecute the Compute command on the object`void Compute()`PublishParameterPublish or un-publish a number attribute as driving parameter`void 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 attribute`SpeosDes.OpticalFeatureStyleStripes.OpticalFeatureStyleStripesCurves Curves`StyleOriginLink attribute`SpeosDes.OpticalFeatureStyleStripes.OpticalFeatureStyleStripesStyleOrigin StyleOrigin`StyleAxisLink attribute`SpeosDes.OpticalFeatureStyleStripes.OpticalFeatureStyleStripesStyleAxis StyleAxis`ReverseStyleAxisBoolean attribute`bool ReverseStyleAxis`StyleOrientationLink attribute`SpeosDes.OpticalFeatureStyleStripes.OpticalFeatureStyleStripesStyleOrientation StyleOrientation`ReverseStyleOrientationBoolean attribute`bool ReverseStyleOrientation`SubjectDeprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper`SpaceClaim.Api.v261.CustomObject Subject`OccurrenceGet the underlying CustomObject occurrence, associated to the API object wrapper in current API version`object Occurrence`NameGet or Set the name of the object`string Name`VisibleChange the visibility status (same behavior as checking/unchecking on the tree view item)`bool Visible`StatusInfoGet the status of the object (warning or error message)`string StatusInfo`IsUpToDateAsk if the object was modified since its last successful computation`bool IsUpToDate`## OpticalFeatureStyleStripes.OpticalFeatureStyleStripesCurves

### Method

NameDescriptionSyntaxSetLinks attribute: Link to an array of script objects`bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)`SetLinks attribute: Link to an array of document objects`bool Set(SpaceClaim.Api.v261.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 links`void Clear()`SelectAllLinks attribute: Link to all compatible objects in the active context`void SelectAll()`### Property

NameDescriptionSyntaxLinkedObjectsLinks attribute: Get the pointed document objects`IReadOnlyCollection<SpaceClaim.Api.v261.IDocObject> LinkedObjects`ItemLinks attribute: Get a pointed document object by index`SpaceClaim.Api.v261.IDocObject Item`CountLinks attribute: Get the links count`int Count`## OpticalFeatureStyleStripes.OpticalFeatureStyleStripesStyleOrigin

### Method

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

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed object`SpaceClaim.Api.v261.IDocObject LinkedObject`## OpticalFeatureStyleStripes.OpticalFeatureStyleStripesStyleAxis

### Method

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

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed object`SpaceClaim.Api.v261.IDocObject LinkedObject`## OpticalFeatureStyleStripes.OpticalFeatureStyleStripesStyleOrientation

### Method

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

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed object`SpaceClaim.Api.v261.IDocObject LinkedObject`## OpticalGroup

### Method

NameDescriptionSyntaxAddFaceFromCoordinates`void AddFaceFromCoordinates(int xCoordinate, int yCoordinate)`AddFacesFromXCoordinate`void AddFacesFromXCoordinate(int xCoordinate)`AddFacesFromYCoordinate`void AddFacesFromYCoordinate(int yCoordinate)`GetGroupTypePossibleValuesString list attribute: List possible values`IEnumerable<string> GetGroupTypePossibleValues()`FindOccurrenceInActivePartSearch for occurrences of this object in the active Part`object FindOccurrenceInActivePart()`FindOccurrenceInContextOfSearch for occurrences of this object in the specified Part`SpaceClaim.Api.v261.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.v261.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 object`bool Delete()`GetChildSubjectsRetrieve all children as DocObjects`IEnumerable<SpaceClaim.Api.v261.CustomObject> GetChildSubjects()`GetChildrenRetrieve all direct children of a given type`IEnumerable<TSpecificApiType> GetChildren<TSpecificApiType>()`ComputeExecute the Compute command on the object`void Compute()`PublishParameterPublish or un-publish a number attribute as driving parameter`void 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<SpeosDes.OpticalGroup> FromSelection(IEnumerable<SpaceClaim.Api.v261.IDocObject> 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 attribute`double Shift`ShiftTextNumber attribute (as text)`string ShiftText`GeometryOrientationEnum attribute`SpeosDes.OpticalGroup.EnumGeometryOrientation GeometryOrientation`GeometryOrientationIndexEnum attribute (as index)`int GeometryOrientationIndex`FocalNumber attribute`double Focal`FocalTextNumber attribute (as text)`string FocalText`ParabolicApproximationBoolean attribute`bool ParabolicApproximation`XTiltAngleNumber attribute`double XTiltAngle`XTiltAngleTextNumber attribute (as text)`string XTiltAngleText`YTiltAngleNumber attribute`double YTiltAngle`YTiltAngleTextNumber attribute (as text)`string YTiltAngleText`AngleNumber attribute`double Angle`AngleTextNumber attribute (as text)`string AngleText`XRadiusNumber attribute`double XRadius`XRadiusTextNumber attribute (as text)`string XRadiusText`YRadiusNumber attribute`double YRadius`YRadiusTextNumber attribute (as text)`string YRadiusText`RadialRadiusNumber attribute`double RadialRadius`RadialRadiusTextNumber attribute (as text)`string RadialRadiusText`StartRadiusNumber attribute`double StartRadius`StartRadiusTextNumber attribute (as text)`string StartRadiusText`EndRadiusNumber attribute`double EndRadius`EndRadiusTextNumber attribute (as text)`string EndRadiusText`RadiusNumber attribute`double Radius`RadiusTextNumber attribute (as text)`string RadiusText`XStartNumber attribute`double XStart`XStartTextNumber attribute (as text)`string XStartText`XEndNumber attribute`double XEnd`XEndTextNumber attribute (as text)`string XEndText`YStartNumber attribute`double YStart`YStartTextNumber attribute (as text)`string YStartText`YEndNumber attribute`double YEnd`YEndTextNumber attribute (as text)`string YEndText`CenteredOnXSpreadBoolean attribute`bool CenteredOnXSpread`CenteredOnYSpreadBoolean attribute`bool CenteredOnYSpread`SmoothingSectorBoolean attribute`bool SmoothingSector`XCenterNumber attribute`double XCenter`XCenterTextNumber attribute (as text)`string XCenterText`YCenterNumber attribute`double YCenter`YCenterTextNumber attribute (as text)`string YCenterText`SpreadStartNumber attribute`double SpreadStart`SpreadStartTextNumber attribute (as text)`string SpreadStartText`SpreadEndNumber attribute`double SpreadEnd`SpreadEndTextNumber attribute (as text)`string SpreadEndText`TiltNumber attribute`double Tilt`TiltTextNumber attribute (as text)`string TiltText`YSizeNumber attribute`double YSize`YSizeTextNumber attribute (as text)`string YSizeText`XAngleNumber attribute`double XAngle`XAngleTextNumber attribute (as text)`string XAngleText`XPositionNumber attribute`double XPosition`XPositionTextNumber attribute (as text)`string XPositionText`XPositionMinNumber attribute`double XPositionMin`XPositionMinTextNumber attribute (as text)`string XPositionMinText`XPositionMaxNumber attribute`double XPositionMax`XPositionMaxTextNumber attribute (as text)`string XPositionMaxText`XAngleMinNumber attribute`double XAngleMin`XAngleMinTextNumber attribute (as text)`string XAngleMinText`XAngleMaxNumber attribute`double XAngleMax`XAngleMaxTextNumber attribute (as text)`string XAngleMaxText`YAngleNumber attribute`double YAngle`YAngleTextNumber attribute (as text)`string YAngleText`YPositionNumber attribute`double YPosition`YPositionTextNumber attribute (as text)`string YPositionText`YPositionMinNumber attribute`double YPositionMin`YPositionMinTextNumber attribute (as text)`string YPositionMinText`YPositionMaxNumber attribute`double YPositionMax`YPositionMaxTextNumber attribute (as text)`string YPositionMaxText`YAngleMinNumber attribute`double YAngleMin`YAngleMinTextNumber attribute (as text)`string YAngleMinText`YAngleMaxNumber attribute`double YAngleMax`YAngleMaxTextNumber attribute (as text)`string YAngleMaxText`XSpreadNumber attribute`double XSpread`XSpreadTextNumber attribute (as text)`string XSpreadText`YSpreadNumber attribute`double YSpread`YSpreadTextNumber attribute (as text)`string YSpreadText`AdvancedModeBoolean attribute`bool AdvancedMode`SCOHControlPlanesChildren attribute`SpeosDes.OpticalGroup.OpticalGroupSCOHControlPlanes SCOHControlPlanes`SCOVControlPlanesChildren attribute`SpeosDes.OpticalGroup.OpticalGroupSCOVControlPlanes SCOVControlPlanes`StartAngleNumber attribute`double StartAngle`StartAngleTextNumber attribute (as text)`string StartAngleText`EndAngleNumber attribute`double EndAngle`EndAngleTextNumber attribute (as text)`string EndAngleText`XRadiusPrismNumber attribute`double XRadiusPrism`XRadiusPrismTextNumber attribute (as text)`string XRadiusPrismText`YRadiusPrismNumber attribute`double YRadiusPrism`YRadiusPrismTextNumber attribute (as text)`string YRadiusPrismText`HeightNumber attribute`double Height`HeightTextNumber attribute (as text)`string HeightText`FaceListLinks attribute`SpeosDes.OpticalGroup.OpticalGroupFaceList FaceList`GroupTypeString list selection attribute`string GroupType`SubjectDeprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper`SpaceClaim.Api.v261.CustomObject Subject`OccurrenceGet the underlying CustomObject occurrence, associated to the API object wrapper in current API version`object Occurrence`NameGet or Set the name of the object`string Name`VisibleChange the visibility status (same behavior as checking/unchecking on the tree view item)`bool Visible`StatusInfoGet the status of the object (warning or error message)`string StatusInfo`IsUpToDateAsk if the object was modified since its last successful computation`bool IsUpToDate`## OpticalGroup.OpticalGroupSCOHControlPlanes

### Method

NameDescriptionSyntaxSetChildren attribute: Set from an array of script objects`bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)`SetChildren attribute: Set from an array of document objects`bool Set(SpaceClaim.Api.v261.IDocObject[] selectedObjects)`SetChildren attribute: Set from an array of objects (IDocObject type from unspecified version)`bool Set(System.Object[] docObjectsFromPreviousVersion)`GetEnumeratorChildren attribute: Get children enumeration`IEnumerator<SpeosDes.ControlPlane> GetEnumerator()`AddNewChildren attribute: Create a new child object`SpeosDes.ControlPlane AddNew(int insertIndex)`DeleteChildren attribute: Delete a child object by index`bool Delete(int index)`ClearChildren attribute: Empty the list`void Clear()`SelectAllChildren attribute: Create children for all objects that are compatible with link selection.`void SelectAll()`### Property

NameDescriptionSyntaxLinkedObjectsChildren attribute: Get linked objects`IReadOnlyCollection<SpaceClaim.Api.v261.IDocObject> LinkedObjects`CountChildren attribute: Get children count`int Count`ListChildren attribute: Get children collection`IReadOnlyCollection<SpeosDes.ControlPlane> List`ItemChildren attribute: Get child by index`SpeosDes.ControlPlane Item`## OpticalGroup.OpticalGroupSCOVControlPlanes

### Method

NameDescriptionSyntaxSetChildren attribute: Set from an array of script objects`bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)`SetChildren attribute: Set from an array of document objects`bool Set(SpaceClaim.Api.v261.IDocObject[] selectedObjects)`SetChildren attribute: Set from an array of objects (IDocObject type from unspecified version)`bool Set(System.Object[] docObjectsFromPreviousVersion)`GetEnumeratorChildren attribute: Get children enumeration`IEnumerator<SpeosDes.ControlPlane> GetEnumerator()`AddNewChildren attribute: Create a new child object`SpeosDes.ControlPlane AddNew(int insertIndex)`DeleteChildren attribute: Delete a child object by index`bool Delete(int index)`ClearChildren attribute: Empty the list`void Clear()`SelectAllChildren attribute: Create children for all objects that are compatible with link selection.`void SelectAll()`### Property

NameDescriptionSyntaxLinkedObjectsChildren attribute: Get linked objects`IReadOnlyCollection<SpaceClaim.Api.v261.IDocObject> LinkedObjects`CountChildren attribute: Get children count`int Count`ListChildren attribute: Get children collection`IReadOnlyCollection<SpeosDes.ControlPlane> List`ItemChildren attribute: Get child by index`SpeosDes.ControlPlane Item`## OpticalGroup.OpticalGroupFaceList

### Method

NameDescriptionSyntaxSetLinks attribute: Link to an array of script objects`bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)`SetLinks attribute: Link to an array of document objects`bool Set(SpaceClaim.Api.v261.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 links`void Clear()`SelectAllLinks attribute: Link to all compatible objects in the active context`void SelectAll()`### Property

NameDescriptionSyntaxLinkedObjectsLinks attribute: Get the pointed document objects`IReadOnlyCollection<SpaceClaim.Api.v261.IDocObject> LinkedObjects`ItemLinks attribute: Get a pointed document object by index`SpaceClaim.Api.v261.IDocObject Item`CountLinks attribute: Get the links count`int Count`## ParabolicSurface

### Static method

NameDescriptionSyntaxFromSelectionConvert Items of a ScriptSelection to a list of Speos objects when their type is matching.`IEnumerable<SpeosDes.ParabolicSurface> FromSelection(IEnumerable<SpaceClaim.Api.v261.IDocObject> 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 component`SpeosDes.ParabolicSurface Create(object parent)`CreateCreate a new object in the active context`SpeosDes.ParabolicSurface Create()`### Method

NameDescriptionSyntaxCloneCreate a copy of this object in the active context`SpeosDes.ParabolicSurface Clone()`CopyToCreate a copy of this object and paste it to the specified destination`SpeosDes.ParabolicSurface CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)`FindOccurrenceInActivePartSearch for occurrences of this object in the active Part`object FindOccurrenceInActivePart()`FindOccurrenceInContextOfSearch for occurrences of this object in the specified Part`SpaceClaim.Api.v261.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.v261.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 object`bool Delete()`GetChildSubjectsRetrieve all children as DocObjects`IEnumerable<SpaceClaim.Api.v261.CustomObject> GetChildSubjects()`GetChildrenRetrieve all direct children of a given type`IEnumerable<TSpecificApiType> GetChildren<TSpecificApiType>()`ComputeExecute the Compute command on the object`void Compute()`PublishParameterPublish or un-publish a number attribute as driving parameter`void 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 attribute`SpeosDes.ParabolicSurface.ParabolicSurfaceOriginPoint OriginPoint`AxisLink attribute`SpeosDes.ParabolicSurface.ParabolicSurfaceAxis Axis`OrientationAxisLink attribute`SpeosDes.ParabolicSurface.ParabolicSurfaceOrientationAxis OrientationAxis`SizeNumber attribute`double Size`SizeTextNumber attribute (as text)`string SizeText`BuildTypeEnum attribute`SpeosDes.ParabolicSurface.EnumBuildType BuildType`BuildTypeIndexEnum attribute (as index)`int BuildTypeIndex`FocalNumber attribute`double Focal`FocalTextNumber attribute (as text)`string FocalText`FocalOutNumber attribute`double FocalOut`FocalOutTextNumber attribute (as text)`string FocalOutText`PassingPointLink attribute`SpeosDes.ParabolicSurface.ParabolicSurfacePassingPoint PassingPoint`ReverseOpticalAxisBoolean attribute`bool ReverseOpticalAxis`SubjectDeprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper`SpaceClaim.Api.v261.CustomObject Subject`OccurrenceGet the underlying CustomObject occurrence, associated to the API object wrapper in current API version`object Occurrence`NameGet or Set the name of the object`string Name`VisibleChange the visibility status (same behavior as checking/unchecking on the tree view item)`bool Visible`StatusInfoGet the status of the object (warning or error message)`string StatusInfo`IsUpToDateAsk if the object was modified since its last successful computation`bool IsUpToDate`## ParabolicSurface.ParabolicSurfaceOriginPoint

### Method

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

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed object`SpaceClaim.Api.v261.IDocObject LinkedObject`## ParabolicSurface.ParabolicSurfaceAxis

### Method

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

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed object`SpaceClaim.Api.v261.IDocObject LinkedObject`## ParabolicSurface.ParabolicSurfaceOrientationAxis

### Method

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

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed object`SpaceClaim.Api.v261.IDocObject LinkedObject`## ParabolicSurface.ParabolicSurfacePassingPoint

### Method

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

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed object`SpaceClaim.Api.v261.IDocObject LinkedObject`## PER

### Static method

NameDescriptionSyntaxFromSelectionConvert Items of a ScriptSelection to a list of Speos objects when their type is matching.`IEnumerable<SpeosDes.PER> FromSelection(IEnumerable<SpaceClaim.Api.v261.IDocObject> 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 component`SpeosDes.PER Create(object parent)`CreateCreate a new object in the active context`SpeosDes.PER Create()`### Method

NameDescriptionSyntaxCloneCreate a copy of this object in the active context`SpeosDes.PER Clone()`CopyToCreate a copy of this object and paste it to the specified destination`SpeosDes.PER CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)`FindOccurrenceInActivePartSearch for occurrences of this object in the active Part`object FindOccurrenceInActivePart()`FindOccurrenceInContextOfSearch for occurrences of this object in the specified Part`SpaceClaim.Api.v261.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.v261.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 object`bool Delete()`GetChildSubjectsRetrieve all children as DocObjects`IEnumerable<SpaceClaim.Api.v261.CustomObject> GetChildSubjects()`GetChildrenRetrieve all direct children of a given type`IEnumerable<TSpecificApiType> GetChildren<TSpecificApiType>()`ComputeExecute the Compute command on the object`void Compute()`PublishParameterPublish or un-publish a number attribute as driving parameter`void 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 attribute`SpeosDes.PER.EnumSourceType SourceType`SourceTypeIndexEnum attribute (as index)`int SourceTypeIndex`SourcePointLink attribute`SpeosDes.PER.PERSourcePoint SourcePoint`SourceSupportLink attribute`SpeosDes.PER.PERSourceSupport SourceSupport`ImagePointLink attribute`SpeosDes.PER.PERImagePoint ImagePoint`OrientationAxisLink attribute`SpeosDes.PER.PEROrientationAxis OrientationAxis`ReverseOrientationAxisDirectionBoolean attribute`bool ReverseOrientationAxisDirection`FocalLengthNumber attribute`double FocalLength`FocalLengthTextNumber attribute (as text)`string FocalLengthText`HoleBoolean attribute`bool Hole`HoleDiameterNumber attribute`double HoleDiameter`HoleDiameterTextNumber attribute (as text)`string HoleDiameterText`SymmetryEnum attribute`SpeosDes.PER.EnumSymmetry Symmetry`SymmetryIndexEnum attribute (as index)`int SymmetryIndex`AngularSectionsChildren CustomObjects attribute`SpeosDes.PER.PERAngularSections AngularSections`SubjectDeprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper`SpaceClaim.Api.v261.CustomObject Subject`OccurrenceGet the underlying CustomObject occurrence, associated to the API object wrapper in current API version`object Occurrence`NameGet or Set the name of the object`string Name`VisibleChange the visibility status (same behavior as checking/unchecking on the tree view item)`bool Visible`StatusInfoGet the status of the object (warning or error message)`string StatusInfo`IsUpToDateAsk if the object was modified since its last successful computation`bool IsUpToDate`## PER.PERSourcePoint

### Method

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

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed object`SpaceClaim.Api.v261.IDocObject LinkedObject`## PER.PERSourceSupport

### Method

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

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed object`SpaceClaim.Api.v261.IDocObject LinkedObject`## PER.PERImagePoint

### Method

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

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed object`SpaceClaim.Api.v261.IDocObject LinkedObject`## PER.PEROrientationAxis

### Method

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

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed object`SpaceClaim.Api.v261.IDocObject LinkedObject`## PER.PERAngularSections

### Method

NameDescriptionSyntaxGetEnumeratorGet children CustomObjects enumeration`IEnumerator<SpeosDes.PERAngularSection> GetEnumerator()`AddNewCreate a new child CustomObject`SpeosDes.PERAngularSection AddNew(int insertIndex)`DeleteDelete a child CustomObject by index`void Delete(int index)`### Property

NameDescriptionSyntaxCountGet children CustomObjects count`int Count`ListGet children CustomObjects list`IReadOnlyCollection<SpeosDes.PERAngularSection> List`ItemGet child CustomObject by index`SpeosDes.PERAngularSection Item`ItemGet child CustomObject by index`SpeosDes.PERAngularSection Item`## PERAngularSection

### Static method

NameDescriptionSyntaxFromSelectionConvert Items of a ScriptSelection to a list of Speos objects when their type is matching.`IEnumerable<SpeosDes.PERAngularSection> FromSelection(IEnumerable<SpaceClaim.Api.v261.IDocObject> 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 Part`object FindOccurrenceInActivePart()`FindOccurrenceInContextOfSearch for occurrences of this object in the specified Part`SpaceClaim.Api.v261.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.v261.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 object`bool Delete()`GetChildSubjectsRetrieve all children as DocObjects`IEnumerable<SpaceClaim.Api.v261.CustomObject> GetChildSubjects()`GetChildrenRetrieve all direct children of a given type`IEnumerable<TSpecificApiType> GetChildren<TSpecificApiType>()`ComputeExecute the Compute command on the object`void Compute()`PublishParameterPublish or un-publish a number attribute as driving parameter`void 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 attribute`double Angle`AngleTextNumber attribute (as text)`string AngleText`ControlPlanesChildren attribute`SpeosDes.PERAngularSection.PERAngularSectionControlPlanes ControlPlanes`SubjectDeprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper`SpaceClaim.Api.v261.CustomObject Subject`OccurrenceGet the underlying CustomObject occurrence, associated to the API object wrapper in current API version`object Occurrence`NameGet or Set the name of the object`string Name`VisibleChange the visibility status (same behavior as checking/unchecking on the tree view item)`bool Visible`StatusInfoGet the status of the object (warning or error message)`string StatusInfo`IsUpToDateAsk if the object was modified since its last successful computation`bool IsUpToDate`## PERAngularSection.PERAngularSectionControlPlanes

### Method

NameDescriptionSyntaxSetChildren attribute: Set from an array of script objects`bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)`SetChildren attribute: Set from an array of document objects`bool Set(SpaceClaim.Api.v261.IDocObject[] selectedObjects)`SetChildren attribute: Set from an array of objects (IDocObject type from unspecified version)`bool Set(System.Object[] docObjectsFromPreviousVersion)`GetEnumeratorChildren attribute: Get children enumeration`IEnumerator<SpeosDes.ControlPlane> GetEnumerator()`AddNewChildren attribute: Create a new child object`SpeosDes.ControlPlane AddNew(int insertIndex)`DeleteChildren attribute: Delete a child object by index`bool Delete(int index)`ClearChildren attribute: Empty the list`void Clear()`SelectAllChildren attribute: Create children for all objects that are compatible with link selection.`void SelectAll()`### Property

NameDescriptionSyntaxLinkedObjectsChildren attribute: Get linked objects`IReadOnlyCollection<SpaceClaim.Api.v261.IDocObject> LinkedObjects`CountChildren attribute: Get children count`int Count`ListChildren attribute: Get children collection`IReadOnlyCollection<SpeosDes.ControlPlane> List`ItemChildren attribute: Get child by index`SpeosDes.ControlPlane Item`## PostProcessing

### Static method

NameDescriptionSyntaxFromSelectionConvert Items of a ScriptSelection to a list of Speos objects when their type is matching.`IEnumerable<SpeosDes.PostProcessing> FromSelection(IEnumerable<SpaceClaim.Api.v261.IDocObject> 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 component`SpeosDes.PostProcessing Create(object parent)`CreateCreate a new object in the active context`SpeosDes.PostProcessing Create()`### Method

NameDescriptionSyntaxCloneCreate a copy of this object in the active context`SpeosDes.PostProcessing Clone()`CopyToCreate a copy of this object and paste it to the specified destination`SpeosDes.PostProcessing CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)`FindOccurrenceInActivePartSearch for occurrences of this object in the active Part`object FindOccurrenceInActivePart()`FindOccurrenceInContextOfSearch for occurrences of this object in the specified Part`SpaceClaim.Api.v261.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.v261.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 object`bool Delete()`GetChildSubjectsRetrieve all children as DocObjects`IEnumerable<SpaceClaim.Api.v261.CustomObject> GetChildSubjects()`GetChildrenRetrieve all direct children of a given type`IEnumerable<TSpecificApiType> GetChildren<TSpecificApiType>()`ComputeExecute the Compute command on the object`void Compute()`PublishParameterPublish or un-publish a number attribute as driving parameter`void 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 attribute`SpeosDes.PostProcessing.PostProcessingAssociatedFeature AssociatedFeature`SubjectDeprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper`SpaceClaim.Api.v261.CustomObject Subject`OccurrenceGet the underlying CustomObject occurrence, associated to the API object wrapper in current API version`object Occurrence`NameGet or Set the name of the object`string Name`VisibleChange the visibility status (same behavior as checking/unchecking on the tree view item)`bool Visible`StatusInfoGet the status of the object (warning or error message)`string StatusInfo`IsUpToDateAsk if the object was modified since its last successful computation`bool IsUpToDate`## PostProcessing.PostProcessingAssociatedFeature

### Method

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

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed object`SpaceClaim.Api.v261.IDocObject LinkedObject`## ProjectionLens

### Static method

NameDescriptionSyntaxFromSelectionConvert Items of a ScriptSelection to a list of Speos objects when their type is matching.`IEnumerable<SpeosDes.ProjectionLens> FromSelection(IEnumerable<SpaceClaim.Api.v261.IDocObject> 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 component`SpeosDes.ProjectionLens Create(object parent)`CreateCreate a new object in the active context`SpeosDes.ProjectionLens Create()`### Method

NameDescriptionSyntaxCloneCreate a copy of this object in the active context`SpeosDes.ProjectionLens Clone()`CopyToCreate a copy of this object and paste it to the specified destination`SpeosDes.ProjectionLens CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)`FindOccurrenceInActivePartSearch for occurrences of this object in the active Part`object FindOccurrenceInActivePart()`FindOccurrenceInContextOfSearch for occurrences of this object in the specified Part`SpaceClaim.Api.v261.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.v261.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 object`bool Delete()`GetChildSubjectsRetrieve all children as DocObjects`IEnumerable<SpaceClaim.Api.v261.CustomObject> GetChildSubjects()`GetChildrenRetrieve all direct children of a given type`IEnumerable<TSpecificApiType> GetChildren<TSpecificApiType>()`ComputeExecute the Compute command on the object`void Compute()`PublishParameterPublish or un-publish a number attribute as driving parameter`void 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 attribute`SpeosDes.ProjectionLens.ProjectionLensFocalPoint FocalPoint`OpticalAxisLink attribute`SpeosDes.ProjectionLens.ProjectionLensOpticalAxis OpticalAxis`OpticalAxisReverseBoolean attribute`bool OpticalAxisReverse`BackFocalLengthNumber attribute`double BackFocalLength`BackFocalLengthTextNumber attribute (as text)`string BackFocalLengthText`BackFaceTypeEnum attribute`SpeosDes.ProjectionLens.EnumBackFaceType BackFaceType`BackFaceTypeIndexEnum attribute (as index)`int BackFaceTypeIndex`FrontFaceTypeEnum attribute`SpeosDes.ProjectionLens.EnumFrontFaceType FrontFaceType`FrontFaceTypeIndexEnum attribute (as index)`int FrontFaceTypeIndex`ZernikeOrientationLink attribute`SpeosDes.ProjectionLens.ProjectionLensZernikeOrientation ZernikeOrientation`ZernikeOrientationReverseBoolean attribute`bool ZernikeOrientationReverse`ThicknessSetTypeEnum attribute`SpeosDes.ProjectionLens.EnumThicknessSetType ThicknessSetType`ThicknessSetTypeIndexEnum attribute (as index)`int ThicknessSetTypeIndex`EdgeThicknessNumber attribute`double EdgeThickness`EdgeThicknessTextNumber attribute (as text)`string EdgeThicknessText`EdgeThicknessOutNumber attribute`double EdgeThicknessOut`EdgeThicknessOutTextNumber attribute (as text)`string EdgeThicknessOutText`LensThicknessNumber attribute`double LensThickness`LensThicknessTextNumber attribute (as text)`string LensThicknessText`LensThicknessOutNumber attribute`double LensThicknessOut`LensThicknessOutTextNumber attribute (as text)`string LensThicknessOutText`ConstructionTypeEnum attribute`SpeosDes.ProjectionLens.EnumConstructionType ConstructionType`ConstructionTypeIndexEnum attribute (as index)`int ConstructionTypeIndex`CustomRevolutionBoolean attribute`bool CustomRevolution`RevolutionOriginPointLink attribute`SpeosDes.ProjectionLens.ProjectionLensRevolutionOriginPoint RevolutionOriginPoint`RevolutionAxisLink attribute`SpeosDes.ProjectionLens.ProjectionLensRevolutionAxis RevolutionAxis`RevolutionAxisReverseBoolean attribute`bool RevolutionAxisReverse`ExtrusionAxisLink attribute`SpeosDes.ProjectionLens.ProjectionLensExtrusionAxis ExtrusionAxis`ExtrusionAxisReverseBoolean attribute`bool ExtrusionAxisReverse`ExtrusionStartNumber attribute`double ExtrusionStart`ExtrusionStartTextNumber attribute (as text)`string ExtrusionStartText`ExtrusionEndNumber attribute`double ExtrusionEnd`ExtrusionEndTextNumber attribute (as text)`string ExtrusionEndText`RevolutionStartNumber attribute`double RevolutionStart`RevolutionStartTextNumber attribute (as text)`string RevolutionStartText`RevolutionEndNumber attribute`double RevolutionEnd`RevolutionEndTextNumber attribute (as text)`string RevolutionEndText`BackFaceApertureDiameterNumber attribute`double BackFaceApertureDiameter`BackFaceApertureDiameterTextNumber attribute (as text)`string BackFaceApertureDiameterText`BackRadiusCurvatureNumber attribute`double BackRadiusCurvature`BackRadiusCurvatureTextNumber attribute (as text)`string BackRadiusCurvatureText`BackConicConstantNumber attribute`double BackConicConstant`BackConicConstantTextNumber attribute (as text)`string BackConicConstantText`BackFaceRefractiveIndexNumber attribute`double BackFaceRefractiveIndex`BackFaceRefractiveIndexTextNumber attribute (as text)`string BackFaceRefractiveIndexText`BackFaceFresnelModeEnum attribute`SpeosDes.ProjectionLens.EnumBackFaceFresnelMode BackFaceFresnelMode`BackFaceFresnelModeIndexEnum attribute (as index)`int BackFaceFresnelModeIndex`BackFaceStepNumber attribute`double BackFaceStep`BackFaceStepTextNumber attribute (as text)`string BackFaceStepText`BackFaceHeightNumber attribute`double BackFaceHeight`BackFaceHeightTextNumber attribute (as text)`string BackFaceHeightText`BackFaceDraftAngleNumber attribute`double BackFaceDraftAngle`BackFaceDraftAngleTextNumber attribute (as text)`string BackFaceDraftAngleText`BackFaceAsphericalsChildren attribute`SpeosDes.ProjectionLens.ProjectionLensBackFaceAsphericals BackFaceAsphericals`BackFaceZernikeCoefficientsChildren attribute`SpeosDes.ProjectionLens.ProjectionLensBackFaceZernikeCoefficients BackFaceZernikeCoefficients`FrontFaceApertureDiameterNumber attribute`double FrontFaceApertureDiameter`FrontFaceApertureDiameterTextNumber attribute (as text)`string FrontFaceApertureDiameterText`FrontRadiusCurvatureNumber attribute`double FrontRadiusCurvature`FrontRadiusCurvatureTextNumber attribute (as text)`string FrontRadiusCurvatureText`FrontConicConstantNumber attribute`double FrontConicConstant`FrontConicConstantTextNumber attribute (as text)`string FrontConicConstantText`FrontFaceRefractiveIndexNumber attribute`double FrontFaceRefractiveIndex`FrontFaceRefractiveIndexTextNumber attribute (as text)`string FrontFaceRefractiveIndexText`FrontFaceFresnelModeEnum attribute`SpeosDes.ProjectionLens.EnumFrontFaceFresnelMode FrontFaceFresnelMode`FrontFaceFresnelModeIndexEnum attribute (as index)`int FrontFaceFresnelModeIndex`FrontFaceStepNumber attribute`double FrontFaceStep`FrontFaceStepTextNumber attribute (as text)`string FrontFaceStepText`FrontFaceHeightNumber attribute`double FrontFaceHeight`FrontFaceHeightTextNumber attribute (as text)`string FrontFaceHeightText`FrontFaceDraftAngleNumber attribute`double FrontFaceDraftAngle`FrontFaceDraftAngleTextNumber attribute (as text)`string FrontFaceDraftAngleText`FrontFaceAsphericalsChildren attribute`SpeosDes.ProjectionLens.ProjectionLensFrontFaceAsphericals FrontFaceAsphericals`FrontFaceZernikeCoefficientsChildren attribute`SpeosDes.ProjectionLens.ProjectionLensFrontFaceZernikeCoefficients FrontFaceZernikeCoefficients`SubjectDeprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper`SpaceClaim.Api.v261.CustomObject Subject`OccurrenceGet the underlying CustomObject occurrence, associated to the API object wrapper in current API version`object Occurrence`NameGet or Set the name of the object`string Name`VisibleChange the visibility status (same behavior as checking/unchecking on the tree view item)`bool Visible`StatusInfoGet the status of the object (warning or error message)`string StatusInfo`IsUpToDateAsk if the object was modified since its last successful computation`bool IsUpToDate`## ProjectionLens.ProjectionLensFocalPoint

### Method

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

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed object`SpaceClaim.Api.v261.IDocObject LinkedObject`## ProjectionLens.ProjectionLensOpticalAxis

### Method

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

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed object`SpaceClaim.Api.v261.IDocObject LinkedObject`## ProjectionLens.ProjectionLensZernikeOrientation

### Method

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

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed object`SpaceClaim.Api.v261.IDocObject LinkedObject`## ProjectionLens.ProjectionLensRevolutionOriginPoint

### Method

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

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed object`SpaceClaim.Api.v261.IDocObject LinkedObject`## ProjectionLens.ProjectionLensRevolutionAxis

### Method

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

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed object`SpaceClaim.Api.v261.IDocObject LinkedObject`## ProjectionLens.ProjectionLensExtrusionAxis

### Method

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

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed object`SpaceClaim.Api.v261.IDocObject LinkedObject`## ProjectionLens.ProjectionLensBackFaceAsphericals

### Method

NameDescriptionSyntaxSetChildren attribute: Set from an array of script objects`bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)`SetChildren attribute: Set from an array of document objects`bool Set(SpaceClaim.Api.v261.IDocObject[] selectedObjects)`SetChildren attribute: Set from an array of objects (IDocObject type from unspecified version)`bool Set(System.Object[] docObjectsFromPreviousVersion)`GetEnumeratorChildren attribute: Get children enumeration`IEnumerator<SpeosDes.Aspherics> GetEnumerator()`SelectAllChildren attribute: Create children for all objects that are compatible with link selection.`void SelectAll()`### Property

NameDescriptionSyntaxLinkedObjectsChildren attribute: Get linked objects`IReadOnlyCollection<SpaceClaim.Api.v261.IDocObject> LinkedObjects`CountChildren attribute: Get children count`int Count`ListChildren attribute: Get children collection`IReadOnlyCollection<SpeosDes.Aspherics> List`ItemChildren attribute: Get child by index`SpeosDes.Aspherics Item`## ProjectionLens.ProjectionLensBackFaceZernikeCoefficients

### Method

NameDescriptionSyntaxSetChildren attribute: Set from an array of script objects`bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)`SetChildren attribute: Set from an array of document objects`bool Set(SpaceClaim.Api.v261.IDocObject[] selectedObjects)`SetChildren attribute: Set from an array of objects (IDocObject type from unspecified version)`bool Set(System.Object[] docObjectsFromPreviousVersion)`GetEnumeratorChildren attribute: Get children enumeration`IEnumerator<SpeosDes.ZernikeCoefficient> GetEnumerator()`SelectAllChildren attribute: Create children for all objects that are compatible with link selection.`void SelectAll()`### Property

NameDescriptionSyntaxLinkedObjectsChildren attribute: Get linked objects`IReadOnlyCollection<SpaceClaim.Api.v261.IDocObject> LinkedObjects`CountChildren attribute: Get children count`int Count`ListChildren attribute: Get children collection`IReadOnlyCollection<SpeosDes.ZernikeCoefficient> List`ItemChildren attribute: Get child by index`SpeosDes.ZernikeCoefficient Item`## ProjectionLens.ProjectionLensFrontFaceAsphericals

### Method

NameDescriptionSyntaxSetChildren attribute: Set from an array of script objects`bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)`SetChildren attribute: Set from an array of document objects`bool Set(SpaceClaim.Api.v261.IDocObject[] selectedObjects)`SetChildren attribute: Set from an array of objects (IDocObject type from unspecified version)`bool Set(System.Object[] docObjectsFromPreviousVersion)`GetEnumeratorChildren attribute: Get children enumeration`IEnumerator<SpeosDes.Aspherics> GetEnumerator()`SelectAllChildren attribute: Create children for all objects that are compatible with link selection.`void SelectAll()`### Property

NameDescriptionSyntaxLinkedObjectsChildren attribute: Get linked objects`IReadOnlyCollection<SpaceClaim.Api.v261.IDocObject> LinkedObjects`CountChildren attribute: Get children count`int Count`ListChildren attribute: Get children collection`IReadOnlyCollection<SpeosDes.Aspherics> List`ItemChildren attribute: Get child by index`SpeosDes.Aspherics Item`## ProjectionLens.ProjectionLensFrontFaceZernikeCoefficients

### Method

NameDescriptionSyntaxSetChildren attribute: Set from an array of script objects`bool Set(Inf.SpaceClaim.Automation.IApiSpeosDocObject[] selectedObjects)`SetChildren attribute: Set from an array of document objects`bool Set(SpaceClaim.Api.v261.IDocObject[] selectedObjects)`SetChildren attribute: Set from an array of objects (IDocObject type from unspecified version)`bool Set(System.Object[] docObjectsFromPreviousVersion)`GetEnumeratorChildren attribute: Get children enumeration`IEnumerator<SpeosDes.ZernikeCoefficient> GetEnumerator()`SelectAllChildren attribute: Create children for all objects that are compatible with link selection.`void SelectAll()`### Property

NameDescriptionSyntaxLinkedObjectsChildren attribute: Get linked objects`IReadOnlyCollection<SpaceClaim.Api.v261.IDocObject> LinkedObjects`CountChildren attribute: Get children count`int Count`ListChildren attribute: Get children collection`IReadOnlyCollection<SpeosDes.ZernikeCoefficient> List`ItemChildren attribute: Get child by index`SpeosDes.ZernikeCoefficient Item`## RectangularLens

### Static method

NameDescriptionSyntaxFromSelectionConvert Items of a ScriptSelection to a list of Speos objects when their type is matching.`IEnumerable<SpeosDes.RectangularLens> FromSelection(IEnumerable<SpaceClaim.Api.v261.IDocObject> 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 component`SpeosDes.RectangularLens Create(object parent)`CreateCreate a new object in the active context`SpeosDes.RectangularLens Create()`### Method

NameDescriptionSyntaxCloneCreate a copy of this object in the active context`SpeosDes.RectangularLens Clone()`CopyToCreate a copy of this object and paste it to the specified destination`SpeosDes.RectangularLens CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)`AddGroupCall the 'AddGroup' command.`void AddGroup()`FindOccurrenceInActivePartSearch for occurrences of this object in the active Part`object FindOccurrenceInActivePart()`FindOccurrenceInContextOfSearch for occurrences of this object in the specified Part`SpaceClaim.Api.v261.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.v261.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 object`bool Delete()`GetChildSubjectsRetrieve all children as DocObjects`IEnumerable<SpaceClaim.Api.v261.CustomObject> GetChildSubjects()`GetChildrenRetrieve all direct children of a given type`IEnumerable<TSpecificApiType> GetChildren<TSpecificApiType>()`ComputeExecute the Compute command on the object`void Compute()`PublishParameterPublish or un-publish a number attribute as driving parameter`void 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 attribute`SpeosDes.OpticalFeatureStyleRectangular Style`GeneralChild CustomObject attribute`SpeosDes.OpticalFeatureGeneral General`GroupsChildren CustomObjects attribute`SpeosDes.RectangularLens.RectangularLensGroups Groups`TirLensChildren CustomObjects attribute`SpeosDes.RectangularLens.RectangularLensTirLens TirLens`ManufacturingChild CustomObject attribute`SpeosDes.OpticalFeatureManufacturing Manufacturing`ExcelFileFile attribute`Speos.Foundation.Utils.File.FilePath ExcelFile`ExcelFileFullPathFile attribute (absolute full path)`string ExcelFileFullPath`SubjectDeprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper`SpaceClaim.Api.v261.CustomObject Subject`OccurrenceGet the underlying CustomObject occurrence, associated to the API object wrapper in current API version`object Occurrence`NameGet or Set the name of the object`string Name`VisibleChange the visibility status (same behavior as checking/unchecking on the tree view item)`bool Visible`StatusInfoGet the status of the object (warning or error message)`string StatusInfo`IsUpToDateAsk if the object was modified since its last successful computation`bool IsUpToDate`## RectangularLens.RectangularLensGroups

### Method

NameDescriptionSyntaxGetEnumeratorGet children CustomObjects enumeration`IEnumerator<SpeosDes.OpticalGroup> GetEnumerator()`AddNewCreate a new child CustomObject`SpeosDes.OpticalGroup AddNew(int insertIndex)`DeleteDelete a child CustomObject by index`void Delete(int index)`### Property

NameDescriptionSyntaxCountGet children CustomObjects count`int Count`ListGet children CustomObjects list`IReadOnlyCollection<SpeosDes.OpticalGroup> List`ItemGet child CustomObject by index`SpeosDes.OpticalGroup Item`ItemGet child CustomObject by index`SpeosDes.OpticalGroup Item`## RectangularLens.RectangularLensTirLens

### Method

NameDescriptionSyntaxGetEnumeratorGet children CustomObjects enumeration`IEnumerator<SpeosDes.TIRLens> GetEnumerator()`AddNewCreate a new child CustomObject`SpeosDes.TIRLens AddNew(int insertIndex)`DeleteDelete a child CustomObject by index`void Delete(int index)`### Property

NameDescriptionSyntaxCountGet children CustomObjects count`int Count`ListGet children CustomObjects list`IReadOnlyCollection<SpeosDes.TIRLens> List`ItemGet child CustomObject by index`SpeosDes.TIRLens Item`ItemGet child CustomObject by index`SpeosDes.TIRLens Item`## RectangularSurface

### Static method

NameDescriptionSyntaxFromSelectionConvert Items of a ScriptSelection to a list of Speos objects when their type is matching.`IEnumerable<SpeosDes.RectangularSurface> FromSelection(IEnumerable<SpaceClaim.Api.v261.IDocObject> 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 component`SpeosDes.RectangularSurface Create(object parent)`CreateCreate a new object in the active context`SpeosDes.RectangularSurface Create()`### Method

NameDescriptionSyntaxCloneCreate a copy of this object in the active context`SpeosDes.RectangularSurface Clone()`CopyToCreate a copy of this object and paste it to the specified destination`SpeosDes.RectangularSurface CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)`AddGroupCall the 'AddGroup' command.`void AddGroup()`FindOccurrenceInActivePartSearch for occurrences of this object in the active Part`object FindOccurrenceInActivePart()`FindOccurrenceInContextOfSearch for occurrences of this object in the specified Part`SpaceClaim.Api.v261.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.v261.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 object`bool Delete()`GetChildSubjectsRetrieve all children as DocObjects`IEnumerable<SpaceClaim.Api.v261.CustomObject> GetChildSubjects()`GetChildrenRetrieve all direct children of a given type`IEnumerable<TSpecificApiType> GetChildren<TSpecificApiType>()`ComputeExecute the Compute command on the object`void Compute()`PublishParameterPublish or un-publish a number attribute as driving parameter`void 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 attribute`SpeosDes.OpticalFeatureStyleRectangular Style`GeneralChild CustomObject attribute`SpeosDes.OpticalFeatureGeneral General`GroupsChildren CustomObjects attribute`SpeosDes.RectangularSurface.RectangularSurfaceGroups Groups`TirLensChildren CustomObjects attribute`SpeosDes.RectangularSurface.RectangularSurfaceTirLens TirLens`ManufacturingChild CustomObject attribute`SpeosDes.OpticalFeatureManufacturing Manufacturing`ExcelFileFile attribute`Speos.Foundation.Utils.File.FilePath ExcelFile`ExcelFileFullPathFile attribute (absolute full path)`string ExcelFileFullPath`SubjectDeprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper`SpaceClaim.Api.v261.CustomObject Subject`OccurrenceGet the underlying CustomObject occurrence, associated to the API object wrapper in current API version`object Occurrence`NameGet or Set the name of the object`string Name`VisibleChange the visibility status (same behavior as checking/unchecking on the tree view item)`bool Visible`StatusInfoGet the status of the object (warning or error message)`string StatusInfo`IsUpToDateAsk if the object was modified since its last successful computation`bool IsUpToDate`## RectangularSurface.RectangularSurfaceGroups

### Method

NameDescriptionSyntaxGetEnumeratorGet children CustomObjects enumeration`IEnumerator<SpeosDes.OpticalGroup> GetEnumerator()`AddNewCreate a new child CustomObject`SpeosDes.OpticalGroup AddNew(int insertIndex)`DeleteDelete a child CustomObject by index`void Delete(int index)`### Property

NameDescriptionSyntaxCountGet children CustomObjects count`int Count`ListGet children CustomObjects list`IReadOnlyCollection<SpeosDes.OpticalGroup> List`ItemGet child CustomObject by index`SpeosDes.OpticalGroup Item`ItemGet child CustomObject by index`SpeosDes.OpticalGroup Item`## RectangularSurface.RectangularSurfaceTirLens

### Method

NameDescriptionSyntaxGetEnumeratorGet children CustomObjects enumeration`IEnumerator<SpeosDes.TIRLens> GetEnumerator()`AddNewCreate a new child CustomObject`SpeosDes.TIRLens AddNew(int insertIndex)`DeleteDelete a child CustomObject by index`void Delete(int index)`### Property

NameDescriptionSyntaxCountGet children CustomObjects count`int Count`ListGet children CustomObjects list`IReadOnlyCollection<SpeosDes.TIRLens> List`ItemGet child CustomObject by index`SpeosDes.TIRLens Item`ItemGet child CustomObject by index`SpeosDes.TIRLens Item`## ResultHOD

### Static method

NameDescriptionSyntaxFromSelectionConvert Items of a ScriptSelection to a list of Speos objects when their type is matching.`IEnumerable<SpeosDes.ResultHOD> FromSelection(IEnumerable<SpaceClaim.Api.v261.IDocObject> 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 Part`object FindOccurrenceInActivePart()`FindOccurrenceInContextOfSearch for occurrences of this object in the specified Part`SpaceClaim.Api.v261.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.v261.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 object`bool Delete()`GetChildSubjectsRetrieve all children as DocObjects`IEnumerable<SpaceClaim.Api.v261.CustomObject> GetChildSubjects()`GetChildrenRetrieve all direct children of a given type`IEnumerable<TSpecificApiType> GetChildren<TSpecificApiType>()`ComputeExecute the Compute command on the object`void Compute()`PublishParameterPublish or un-publish a number attribute as driving parameter`void 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 attribute`SpeosDes.ResultHOD.EnumResultType ResultType`ResultTypeIndexEnum attribute (as index)`int ResultTypeIndex`FullPathGet the result file full path`string FullPath`SubjectDeprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper`SpaceClaim.Api.v261.CustomObject Subject`OccurrenceGet the underlying CustomObject occurrence, associated to the API object wrapper in current API version`object Occurrence`NameGet or Set the name of the object`string Name`VisibleChange the visibility status (same behavior as checking/unchecking on the tree view item)`bool Visible`StatusInfoGet the status of the object (warning or error message)`string StatusInfo`IsUpToDateAsk if the object was modified since its last successful computation`bool IsUpToDate`## StripesLens

### Static method

NameDescriptionSyntaxFromSelectionConvert Items of a ScriptSelection to a list of Speos objects when their type is matching.`IEnumerable<SpeosDes.StripesLens> FromSelection(IEnumerable<SpaceClaim.Api.v261.IDocObject> 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 component`SpeosDes.StripesLens Create(object parent)`CreateCreate a new object in the active context`SpeosDes.StripesLens Create()`### Method

NameDescriptionSyntaxCloneCreate a copy of this object in the active context`SpeosDes.StripesLens Clone()`CopyToCreate a copy of this object and paste it to the specified destination`SpeosDes.StripesLens CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)`AddGroupCall the 'AddGroup' command.`void AddGroup()`FindOccurrenceInActivePartSearch for occurrences of this object in the active Part`object FindOccurrenceInActivePart()`FindOccurrenceInContextOfSearch for occurrences of this object in the specified Part`SpaceClaim.Api.v261.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.v261.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 object`bool Delete()`GetChildSubjectsRetrieve all children as DocObjects`IEnumerable<SpaceClaim.Api.v261.CustomObject> GetChildSubjects()`GetChildrenRetrieve all direct children of a given type`IEnumerable<TSpecificApiType> GetChildren<TSpecificApiType>()`ComputeExecute the Compute command on the object`void Compute()`PublishParameterPublish or un-publish a number attribute as driving parameter`void 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 attribute`SpeosDes.OpticalFeatureStyleStripes Style`GeneralChild CustomObject attribute`SpeosDes.OpticalFeatureGeneral General`GroupsChildren CustomObjects attribute`SpeosDes.StripesLens.StripesLensGroups Groups`TirLensChildren CustomObjects attribute`SpeosDes.StripesLens.StripesLensTirLens TirLens`ManufacturingChild CustomObject attribute`SpeosDes.OpticalFeatureManufacturing Manufacturing`ExcelFileFile attribute`Speos.Foundation.Utils.File.FilePath ExcelFile`ExcelFileFullPathFile attribute (absolute full path)`string ExcelFileFullPath`SubjectDeprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper`SpaceClaim.Api.v261.CustomObject Subject`OccurrenceGet the underlying CustomObject occurrence, associated to the API object wrapper in current API version`object Occurrence`NameGet or Set the name of the object`string Name`VisibleChange the visibility status (same behavior as checking/unchecking on the tree view item)`bool Visible`StatusInfoGet the status of the object (warning or error message)`string StatusInfo`IsUpToDateAsk if the object was modified since its last successful computation`bool IsUpToDate`## StripesLens.StripesLensGroups

### Method

NameDescriptionSyntaxGetEnumeratorGet children CustomObjects enumeration`IEnumerator<SpeosDes.OpticalGroup> GetEnumerator()`AddNewCreate a new child CustomObject`SpeosDes.OpticalGroup AddNew(int insertIndex)`DeleteDelete a child CustomObject by index`void Delete(int index)`### Property

NameDescriptionSyntaxCountGet children CustomObjects count`int Count`ListGet children CustomObjects list`IReadOnlyCollection<SpeosDes.OpticalGroup> List`ItemGet child CustomObject by index`SpeosDes.OpticalGroup Item`ItemGet child CustomObject by index`SpeosDes.OpticalGroup Item`## StripesLens.StripesLensTirLens

### Method

NameDescriptionSyntaxGetEnumeratorGet children CustomObjects enumeration`IEnumerator<SpeosDes.TIRLens> GetEnumerator()`AddNewCreate a new child CustomObject`SpeosDes.TIRLens AddNew(int insertIndex)`DeleteDelete a child CustomObject by index`void Delete(int index)`### Property

NameDescriptionSyntaxCountGet children CustomObjects count`int Count`ListGet children CustomObjects list`IReadOnlyCollection<SpeosDes.TIRLens> List`ItemGet child CustomObject by index`SpeosDes.TIRLens Item`ItemGet child CustomObject by index`SpeosDes.TIRLens Item`## StripesSurface

### Static method

NameDescriptionSyntaxFromSelectionConvert Items of a ScriptSelection to a list of Speos objects when their type is matching.`IEnumerable<SpeosDes.StripesSurface> FromSelection(IEnumerable<SpaceClaim.Api.v261.IDocObject> 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 component`SpeosDes.StripesSurface Create(object parent)`CreateCreate a new object in the active context`SpeosDes.StripesSurface Create()`### Method

NameDescriptionSyntaxCloneCreate a copy of this object in the active context`SpeosDes.StripesSurface Clone()`CopyToCreate a copy of this object and paste it to the specified destination`SpeosDes.StripesSurface CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)`AddGroupCall the 'AddGroup' command.`void AddGroup()`FindOccurrenceInActivePartSearch for occurrences of this object in the active Part`object FindOccurrenceInActivePart()`FindOccurrenceInContextOfSearch for occurrences of this object in the specified Part`SpaceClaim.Api.v261.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.v261.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 object`bool Delete()`GetChildSubjectsRetrieve all children as DocObjects`IEnumerable<SpaceClaim.Api.v261.CustomObject> GetChildSubjects()`GetChildrenRetrieve all direct children of a given type`IEnumerable<TSpecificApiType> GetChildren<TSpecificApiType>()`ComputeExecute the Compute command on the object`void Compute()`PublishParameterPublish or un-publish a number attribute as driving parameter`void 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 attribute`SpeosDes.OpticalFeatureStyleStripes Style`GeneralChild CustomObject attribute`SpeosDes.OpticalFeatureGeneral General`GroupsChildren CustomObjects attribute`SpeosDes.StripesSurface.StripesSurfaceGroups Groups`TirLensChildren CustomObjects attribute`SpeosDes.StripesSurface.StripesSurfaceTirLens TirLens`ManufacturingChild CustomObject attribute`SpeosDes.OpticalFeatureManufacturing Manufacturing`ExcelFileFile attribute`Speos.Foundation.Utils.File.FilePath ExcelFile`ExcelFileFullPathFile attribute (absolute full path)`string ExcelFileFullPath`SubjectDeprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper`SpaceClaim.Api.v261.CustomObject Subject`OccurrenceGet the underlying CustomObject occurrence, associated to the API object wrapper in current API version`object Occurrence`NameGet or Set the name of the object`string Name`VisibleChange the visibility status (same behavior as checking/unchecking on the tree view item)`bool Visible`StatusInfoGet the status of the object (warning or error message)`string StatusInfo`IsUpToDateAsk if the object was modified since its last successful computation`bool IsUpToDate`## StripesSurface.StripesSurfaceGroups

### Method

NameDescriptionSyntaxGetEnumeratorGet children CustomObjects enumeration`IEnumerator<SpeosDes.OpticalGroup> GetEnumerator()`AddNewCreate a new child CustomObject`SpeosDes.OpticalGroup AddNew(int insertIndex)`DeleteDelete a child CustomObject by index`void Delete(int index)`### Property

NameDescriptionSyntaxCountGet children CustomObjects count`int Count`ListGet children CustomObjects list`IReadOnlyCollection<SpeosDes.OpticalGroup> List`ItemGet child CustomObject by index`SpeosDes.OpticalGroup Item`ItemGet child CustomObject by index`SpeosDes.OpticalGroup Item`## StripesSurface.StripesSurfaceTirLens

### Method

NameDescriptionSyntaxGetEnumeratorGet children CustomObjects enumeration`IEnumerator<SpeosDes.TIRLens> GetEnumerator()`AddNewCreate a new child CustomObject`SpeosDes.TIRLens AddNew(int insertIndex)`DeleteDelete a child CustomObject by index`void Delete(int index)`### Property

NameDescriptionSyntaxCountGet children CustomObjects count`int Count`ListGet children CustomObjects list`IReadOnlyCollection<SpeosDes.TIRLens> List`ItemGet child CustomObject by index`SpeosDes.TIRLens Item`ItemGet child CustomObject by index`SpeosDes.TIRLens Item`## TIRLens

### Static method

NameDescriptionSyntaxFromSelectionConvert Items of a ScriptSelection to a list of Speos objects when their type is matching.`IEnumerable<SpeosDes.TIRLens> FromSelection(IEnumerable<SpaceClaim.Api.v261.IDocObject> 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 component`SpeosDes.TIRLens Create(object parent)`CreateCreate a new object in the active context`SpeosDes.TIRLens Create()`### Method

NameDescriptionSyntaxCloneCreate a copy of this object in the active context`SpeosDes.TIRLens Clone()`CopyToCreate a copy of this object and paste it to the specified destination`SpeosDes.TIRLens CopyTo(Inf.SpaceClaim.Automation.IApiSpeosDocObject pasteTargetObject)`FindOccurrenceInActivePartSearch for occurrences of this object in the active Part`object FindOccurrenceInActivePart()`FindOccurrenceInContextOfSearch for occurrences of this object in the specified Part`SpaceClaim.Api.v261.IDocObject FindOccurrenceInContextOf(SpaceClaim.Api.v261.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 object`bool Delete()`GetChildSubjectsRetrieve all children as DocObjects`IEnumerable<SpaceClaim.Api.v261.CustomObject> GetChildSubjects()`GetChildrenRetrieve all direct children of a given type`IEnumerable<TSpecificApiType> GetChildren<TSpecificApiType>()`ComputeExecute the Compute command on the object`void Compute()`PublishParameterPublish or un-publish a number attribute as driving parameter`void 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 attribute`SpeosDes.TIRLens.EnumBuildType BuildType`BuildTypeIndexEnum attribute (as index)`int BuildTypeIndex`SourceLink attribute`SpeosDes.TIRLens.TIRLensSource Source`OpticalAxisLink attribute`SpeosDes.TIRLens.TIRLensOpticalAxis OpticalAxis`SupportPlaneLink attribute`SpeosDes.TIRLens.TIRLensSupportPlane SupportPlane`InputRadiusNumber attribute`double InputRadius`InputRadiusTextNumber attribute (as text)`string InputRadiusText`DepthNumber attribute`double Depth`DepthTextNumber attribute (as text)`string DepthText`DraftAngleNumber attribute`double DraftAngle`DraftAngleTextNumber attribute (as text)`string DraftAngleText`SupportThicknessNumber attribute`double SupportThickness`SupportThicknessTextNumber attribute (as text)`string SupportThicknessText`RefractiveIndexNumber attribute`double RefractiveIndex`RefractiveIndexTextNumber attribute (as text)`string RefractiveIndexText`ThicknessNumber attribute`double Thickness`ThicknessTextNumber attribute (as text)`string ThicknessText`ThicknessOutNumber attribute`double ThicknessOut`ThicknessOutTextNumber attribute (as text)`string ThicknessOutText`OutputDiameterNumber attribute`double OutputDiameter`OutputDiameterTextNumber attribute (as text)`string OutputDiameterText`OutputDiameterOutNumber attribute`double OutputDiameterOut`OutputDiameterOutTextNumber attribute (as text)`string OutputDiameterOutText`FocalNumber attribute`double Focal`FocalTextNumber attribute (as text)`string FocalText`ReverseDirectionBoolean attribute`bool ReverseDirection`SpreadNumber attribute`double Spread`SpreadTextNumber attribute (as text)`string SpreadText`SpreadBehaviorEnum attribute`SpeosDes.TIRLens.EnumSpreadBehavior SpreadBehavior`SpreadBehaviorIndexEnum attribute (as index)`int SpreadBehaviorIndex`SpreadControlNumber attribute`double SpreadControl`SpreadControlTextNumber attribute (as text)`string SpreadControlText`SubjectDeprecated : Use 'Occurrence' property instead Get the underlying CustomObject, associated to the API object wrapper`SpaceClaim.Api.v261.CustomObject Subject`OccurrenceGet the underlying CustomObject occurrence, associated to the API object wrapper in current API version`object Occurrence`NameGet or Set the name of the object`string Name`VisibleChange the visibility status (same behavior as checking/unchecking on the tree view item)`bool Visible`StatusInfoGet the status of the object (warning or error message)`string StatusInfo`IsUpToDateAsk if the object was modified since its last successful computation`bool IsUpToDate`## TIRLens.TIRLensSource

### Method

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

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed object`SpaceClaim.Api.v261.IDocObject LinkedObject`## TIRLens.TIRLensOpticalAxis

### Method

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

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed object`SpaceClaim.Api.v261.IDocObject LinkedObject`## TIRLens.TIRLensSupportPlane

### Method

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

NameDescriptionSyntaxLinkedObjectLink attribute: Get the pointed object`SpaceClaim.Api.v261.IDocObject LinkedObject`## ZernikeCoefficient

### Static method

NameDescriptionSyntaxCreateCreate a new object of this type`SpeosDes.ZernikeCoefficient Create()`### Method

NameDescriptionSyntaxToString`string ToString()`### Property

NameDescriptionSyntaxIndexNumber attribute`int Index`IndexTextNumber attribute (as text)`string IndexText`ValueNumber attribute`double Value`ValueTextNumber attribute (as text)`string ValueText`