CIP C++ documentation for class "wfcSection"

Class wfcSection

# include <wfcSection.h> class wfcSection : public virtual wfcWModel, : public virtual pfcSection2D { xaideclare(wfcSection) ... };

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


`xint`	`AddEntity (wfcSectionEntity_ptr Ent)`
	Add an entity to section.

`void`	`AutoDimension ()`


`void`	`DeleteEntity (xint EntId)`
	Delete an entity from section.

`wfcSectionEntity_ptr`	`GetEntity (xint EntId)`
	Get an entity from section.

`xintsequence_ptr`	`GetEntityIds ()`
	Get Identifier of all valid entities in the section

`xreal`	`GetEpsilon ()`
	Gets epsilon value of the section

`xbool`	`GetIntentManagerMode ()`
	Check if Intent Manager mode is used for the specified section

`pfcMatrix3D_ptr`	`GetLocation ()`
	Gets location of the section

`optional xstring`	`GetName ()`
	Gets name of the section

`wfcSectionDimIds_ptr`	`GetSectionDimensions ()`
	Returns corresponding arrays of section dimension identifiers and solid dimension identifiers.

`wfcSectionEntities_ptr`	`ListSectionEntities ()`
	Lists entities present in the section

`void`	`Regenerate ()`


`void`	`ReplaceEntity (xint OriginalEntId, xint 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 (xreal Value)`
	Sets epsilon value of the section

`void`	`SetIntentManagerMode (xbool Value)`
	Set Intent manager mode ON or OFF.Section conversion invoking section resolve is done here.

`void`	`SetName (xrstring Name)`
	Sets name of the section

Methods Inherited from Class pfcActionSource:: AddActionListener, RemoveActionListener, AddActionListenerWithType

Methods Inherited from Class pfcParent:: GetChild

Methods Inherited from Class pfcParameterOwner:: GetParam, CreateParam, ListParams, SelectParam, CreateParamWithUnits, SelectParameters

Methods Inherited from Class wfcWParameterOwner:: ExportParameterTable, ApplyParameterTableset

Methods Inherited from Class pfcRelationOwner:: DeleteRelations, GetRelations, SetRelations, RegenerateRelations, EvaluateExpression

Methods Inherited from Class wfcWRelationOwner:: GetRelationConstraints, UnitsUsed, UseUnits, EvaluateExpressionWithUnits

Methods Inherited from Class pfcModelItemOwner:: GetItemByName, GetItemById, ListItems

Methods Inherited from Class pfcViewOwner:: RetrieveView, GetView, SaveView, GetCurrentViewTransform, SetCurrentViewTransform, CurrentViewRotate, ListViews, GetCurrentView

Methods Inherited from Class pfcChild:: GetDBParent, GetOId

Methods Inherited from Class pfcModel:: 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 Class wfcWModel:: 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

xint AddEntity (wfcSectionEntity_ptr Ent)

Add an entity to section.

Exceptions thrown (but not limited to):

pfcXToolkitOutOfMemory - There was a memory error.

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

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

pfcXToolkitInvalidItem - 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.

void DeleteEntity (xint 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:

wfcSectionEntity_ptr GetEntity (xint EntId)

Get an entity from section.

Exceptions thrown (but not limited to):

pfcXToolkitOutOfMemory - There was a memory error.

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

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

pfcXToolkitInvalidType - 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:

void ReplaceEntity (xint OriginalEntId, xint 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:

void SetIntentManagerMode (xbool 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:

xbool 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.

optional xstring GetName ()

Gets name of the section

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

Returns:: Name of the section

void SetName (xrstring Name)

Sets name of the section

Exceptions thrown (but not limited to):

pfcXToolkitFound - 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:

xreal 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

void SetEpsilon (xreal 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:

pfcMatrix3D_ptr 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

wfcSectionEntities_ptr ListSectionEntities ()

Lists entities present in the section

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

Exceptions thrown (but not limited to):

pfcXToolkitOutOfMemory - There was a memory error.

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

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

pfcXToolkitInvalidType - 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

xintsequence_ptr 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

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):

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

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

Returns:

void Regenerate ()

Returns:

void AutoDimension ()

Returns:

wfcSectionDimIds_ptr 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