CIP JAVA documentation for class "com.ptc.wfc.wfcSection.Section"

Interface Section

package com.ptc.wfc.wfcSection; public interface Section extends com.ptc.wfc.wfcModel.WModel, com.ptc.pfc.pfcSection.Section2D

Description

This interface represents both Section2D and Section3D.

This is the actual type of in Object Toolkit to represent models of pfcMDL_2D_SECTION type.

Method Summary
`int`	`AddEntity (SectionEntity Ent)` Add an entity to section.
`void`	`AutoDimension ()`
`void`	`DeleteEntity (int EntId)` Delete an entity from section.
`SectionEntity`	`GetEntity (int EntId)` Get an entity from section.
`intseq`	`GetEntityIds ()` Get Identifier of all valid entities in the section
`double`	`GetEpsilon ()` Gets epsilon value of the section
`boolean`	`GetIntentManagerMode ()` Check if Intent Manager mode is used for the specified section
`Matrix3D`	`GetLocation ()` Gets location of the section
`/optional/ String`	`GetName ()` Gets name of the section
`SectionDimIds`	`GetSectionDimensions ()` Returns corresponding arrays of section dimension identifiers and solid dimension identifiers.
`SectionEntities`	`ListSectionEntities ()` Lists entities present in the section
`void`	`Regenerate ()`
`void`	`ReplaceEntity (int OriginalEntId, int NewEntId)` Replaces an entity from the specified section with another entity from the same section (for redefine purposes).
`void`	`SetActive ()` Set a copy of the section to be a current active sketcher section.
`void`	`SetEpsilon (double Value)` Sets epsilon value of the section
`void`	`SetIntentManagerMode (boolean Value)` Set Intent manager mode ON or OFF.Section conversion invoking section resolve is done here.
`void`	`SetName (String Name)` Sets name of the section

Methods Inherited from Interface `com.ptc.pfc.pfcBase.ActionSource`
`AddActionListener`, `RemoveActionListener`, `AddActionListenerWithType`

Methods Inherited from Interface `com.ptc.pfc.pfcObject.Parent`
`GetChild`

Methods Inherited from Interface `com.ptc.pfc.pfcModelItem.ParameterOwner`
`GetParam`, `CreateParam`, `ListParams`, `SelectParam`, `CreateParamWithUnits`, `SelectParameters`

Methods Inherited from Interface `com.ptc.wfc.wfcModelItem.WParameterOwner`
`ExportParameterTable`, `ApplyParameterTableset`, `MathcadParametersSet`, `MathcadInputParametersGet`

Methods Inherited from Interface `com.ptc.pfc.pfcModelItem.RelationOwner`
`DeleteRelations`, `GetRelations`, `SetRelations`, `RegenerateRelations`, `EvaluateExpression`

Methods Inherited from Interface `com.ptc.wfc.wfcModelItem.WRelationOwner`
`GetRelationConstraints`, `UnitsUsed`, `UseUnits`, `EvaluateExpressionWithUnits`

Methods Inherited from Interface `com.ptc.pfc.pfcModelItem.ModelItemOwner`
`GetItemByName`, `GetItemById`, `ListItems`

Methods Inherited from Interface `com.ptc.pfc.pfcView.ViewOwner`
`RetrieveView`, `GetView`, `SaveView`, `GetCurrentViewTransform`, `SetCurrentViewTransform`, `CurrentViewRotate`, `ListViews`, `GetCurrentView`

Methods Inherited from Interface `com.ptc.pfc.pfcObject.Child`
`GetDBParent`, `GetOId`

Methods Inherited from Interface `com.ptc.pfc.pfcModel.Model`
`GetDescr`, `GetRelationId`, `GetIsModified`, `GetVersionStamp`, `GetRevision`, `GetVersion`, `GetBranch`, `GetReleaseLevel`, `GetCommonName`, `SetCommonName`, `IsCommonNameModifiable`, `GetFullName`, `GetInstanceName`, `GetGenericName`, `GetType`, `GetFileName`, `Backup`, `Copy`, `CopyAndRetrieve`, `Rename`, `Save`, `Erase`, `EraseWithDependencies`, `Delete`, `Display`, `DisplayInNewWindow`, `ListDependencies`, `ListDeclaredModels`, `CreateLayer`, `Export`, `Import`, `AccessExternalData`, `TerminateExternalData`, `CheckIsSaveAllowed`, `CheckIsModifiable`, `GetOrigin`, `GetPostRegenerationRelations`, `SetPostRegenerationRelations`, `RegeneratePostRegenerationRelations`, `DeletePostRegenerationRelations`, `CleanupDependencies`, `IsNativeModel`, `ExportIntf3D`, `SetIntf3DLayerSetupFile`, `IsIntf3DLayerSetupFileIgnored`, `IsIntf3DCsysIgnored`, `ClearIntf3DModelData`

Methods Inherited from Interface com.ptc.pfc.pfcModel.Model

GetDescr, GetRelationId, GetIsModified, GetVersionStamp, GetRevision, GetVersion, GetBranch, GetReleaseLevel, GetCommonName, SetCommonName, IsCommonNameModifiable, GetFullName, GetInstanceName, GetGenericName, GetType, GetFileName, Backup, Copy, CopyAndRetrieve, Rename, Save, Erase, EraseWithDependencies, Delete, Display, DisplayInNewWindow, ListDependencies, ListDeclaredModels, CreateLayer, Export, Import, AccessExternalData, TerminateExternalData, CheckIsSaveAllowed, CheckIsModifiable, GetOrigin, GetPostRegenerationRelations, SetPostRegenerationRelations, RegeneratePostRegenerationRelations, DeletePostRegenerationRelations, CleanupDependencies, IsNativeModel, ExportIntf3D, SetIntf3DLayerSetupFile, IsIntf3DLayerSetupFileIgnored, IsIntf3DCsysIgnored, ClearIntf3DModelData

Methods Inherited from Interface `com.ptc.wfc.wfcModel.WModel`
`VerifyATB`, `MarkATBModelAsOutOfDate`, `UpdateATB`, `RelinkATB`, `GetAnnotationPlanesFromGallery`, `GetAnnotationPlanes`, `GetAnnotationPlaneByName`, `AddAnnotationPlaneToGallery`, `RemoveAnnotationPlaneFromGallery`, `GetActiveAnnotationPlane`, `GetTIMInfo`, `ConvertOldXSectionsToNew`, `CanCreateSectionFeature`, `ListLayers`, `SaveLayerDisplayStatus`, `GetLayerItem`, `GetSubType`, `GetDefaultName`, `IsVariantFeatModel`, `CreateUnitByExpression`, `ComputeRayIntersections`, `CollectParamTablesets`, `GenerateSelectionsFromCollection`, `MarkForSaving`, `RefreshMdlTree`, `GetMdlfileDescriptor`, `IsStandardLocation`, `DesignateSymbol`, `UndesignateSymbol`, `IsDesignatedSymbol`, `VisitItems`, `VisitDetailItems`, `CreateSurfaceFinish`, `CreateGTol`, `CreateSetDatumTag`, `MatchLayerRules`, `CopyLayerRules`, `ExecuteLayerRules`

Methods Inherited from Interface com.ptc.wfc.wfcModel.WModel

VerifyATB, MarkATBModelAsOutOfDate, UpdateATB, RelinkATB, GetAnnotationPlanesFromGallery, GetAnnotationPlanes, GetAnnotationPlaneByName, AddAnnotationPlaneToGallery, RemoveAnnotationPlaneFromGallery, GetActiveAnnotationPlane, GetTIMInfo, ConvertOldXSectionsToNew, CanCreateSectionFeature, ListLayers, SaveLayerDisplayStatus, GetLayerItem, GetSubType, GetDefaultName, IsVariantFeatModel, CreateUnitByExpression, ComputeRayIntersections, CollectParamTablesets, GenerateSelectionsFromCollection, MarkForSaving, RefreshMdlTree, GetMdlfileDescriptor, IsStandardLocation, DesignateSymbol, UndesignateSymbol, IsDesignatedSymbol, VisitItems, VisitDetailItems, CreateSurfaceFinish, CreateGTol, CreateSetDatumTag, MatchLayerRules, CopyLayerRules, ExecuteLayerRules

Method Detail

AddEntity

int AddEntity (SectionEntity Ent)

Add an entity to section.

Exceptions thrown (but not limited to):

XToolkitOutOfMemory - There was a memory error.

XToolkitLineTooLong - In the case of a Pro2dTextdef being added, the text string exceeded the internal limitation of Creo Parametric.

XToolkitInvalidName - In the case of a Pro2dTextdef being added, the text font is not supported by Creo Parametric.

XToolkitInvalidItem - Invalid entity type

Manual References:: Element Trees: Sections: Section Entities, Element Trees: Sections: Section Entities

Parameters:

Ent: Entity to be added.

Returns:: Identifier of an added entity.

DeleteEntity

void DeleteEntity (int EntId)

Delete an entity from section.

Manual References:: Element Trees: Sections: Section Entities, Element Trees: Sections: Section Entities

Parameters:

EntId: Identifier of an entity to be deleted.

Returns:

GetEntity

SectionEntity GetEntity (int EntId)

Get an entity from section.

Exceptions thrown (but not limited to):

XToolkitOutOfMemory - There was a memory error.

XToolkitLineTooLong - In the case of Pro2dTextdef, the text string exceeded the internal limitation of Creo Parametric.

XToolkitInvalidName - In the case of Pro2dTextdef, the text font name violated the Pro2dTextdef conventions.

XToolkitInvalidType - This Creo Parametric entity type is not available in Creo Parametric TOOLKIT environment.

Manual References:: Element Trees: Sections: Section Entities, Element Trees: Sections: Section Entities

Parameters:

EntId: Identifier of an entity.

Returns:

ReplaceEntity

void ReplaceEntity (int OriginalEntId, int NewEntId)

Replaces an entity from the specified section with another entity from the same section (for redefine purposes).

Parameters:

OriginalEntId: The identifier of the entity to be replaced.
NewEntId: The identifier of the entity to replace the old one.

Returns:

SetIntentManagerMode

void SetIntentManagerMode (boolean Value)

Set Intent manager mode ON or OFF.Section conversion invoking section resolve is done here.

By default Intent Manager is OFF.

Manual References:: Element Trees: Sections: Setting the Intent Manager Mode of a Section, Element Trees: Sections: To Create and Save a Section Model, Element Trees: Sections: Copying the Current Section

Parameters:

Value: Pass value true to turn ON Intent manager mode.

Returns:

GetIntentManagerMode

boolean GetIntentManagerMode ()

Check if Intent Manager mode is used for the specified section

Manual References:: Element Trees: Sections: Setting the Intent Manager Mode of a Section, Element Trees: Sections: Setting the Intent Manager Mode of a Section

Returns:: Returns value true if intent manager mode is used.

GetName

/*optional*/ String GetName ()

Gets name of the section

Manual References:: Element Trees: Sections: Allocating a Two-Dimensional Section

Returns:: Name of the section

SetName

void SetName (String Name)

Sets name of the section

Exceptions thrown (but not limited to):

XToolkitFound - Could not rename the section because another section with this name already exists.

Manual References:: Element Trees: Sections: Allocating a Two-Dimensional Section

Parameters:

Name: Name of section.

Returns:

GetEpsilon

double GetEpsilon ()

Gets epsilon value of the section

Manual References:: Element Trees: Sections: Epsilon Value in Sections, Element Trees: Sections: Epsilon Value in Sections

Returns:: Epsilon value of the section

SetEpsilon

void SetEpsilon (double Value)

Sets epsilon value of the section

Manual References:: Element Trees: Sections: Epsilon Value in Sections

Parameters:

Value: Epsilon value of section to be set.

Returns:

GetLocation

Matrix3D GetLocation ()

Gets location of the section

Manual References:: Element Trees: Sketched Features: 3D Section Location in the Owning Model

Returns:: location matrix of the section

ListSectionEntities

SectionEntities ListSectionEntities ()

Lists entities present in the section

Array size returned by this method may be different from Section.GetEntityIds() since this method does not list dummy entities.

Exceptions thrown (but not limited to):

XToolkitOutOfMemory - There was a memory error.

XToolkitLineTooLong - In the case of Pro2dTextdef, the text string exceeded the internal limitation of Creo Parametric.

XToolkitInvalidName - In the case of Pro2dTextdef, the text font name violated the Pro2dTextdef conventions.

XToolkitInvalidType - This Creo Parametric entity type is not available in Creo Parametric TOOLKIT environment.

Manual References:: Element Trees: Sections: Section Entities, Element Trees: Sections: Section Entities

Returns:: Array of section entities

GetEntityIds

intseq GetEntityIds ()

Get Identifier of all valid entities in the section

Manual References:: Element Trees: Sections: Section Entities, Element Trees: Sections: Section Entities

Returns:: Array of integer identifiers

SetActive

void SetActive ()

Set a copy of the section to be a current active sketcher section.

Caller is responsible for the section validity. This section will also be added to Undo/Redo stack. The section must be solved or to be in Intent Manager mode.

Exceptions thrown (but not limited to):

XToolkitBadContext - Section not in sketcher mode or IntentManager is Off.

Manual References:: Element Trees: Sections: Copying the Current Section

Returns:

Regenerate

void Regenerate ()

Returns:

AutoDimension

void AutoDimension ()

Returns:

GetSectionDimensions

SectionDimIds GetSectionDimensions ()

Returns corresponding arrays of section dimension identifiers and solid dimension identifiers.

Manual References:: Element Trees: Sections: Retrieving a Section, Element Trees: Sections: Retrieving a Section

Returns:: Returns wfcSectionDimIds_ptr