CIP JavaScript documentation for class " pfcFeature"

Class pfcFeature

Description

This class defines a feature.

See Also:: pfcSolid.GetFeatureById(), pfcSolid.GetFeatureByName(), pfcSolid.ListFeaturesByType()

Direct Parent Classes:: pfcModelItem

Direct Known Subclasses:: pfcComponentFeat, pfcDatumAxisFeat, pfcCurveFeat, pfcCoordSysFeat, pfcDatumPlaneFeat, pfcRoundFeat, pfcDatumPointFeat

Property Summary


`/* readonly */ string`	`FeatSubType`
	The feature subtype, i.e. "Extrude" or "Revolve" for a protrusion.

`/* readonly */ pfcFeatureType`	`FeatType`
	The feature type.

`/* readonly */ string`	`FeatTypeName`
	The feature type expressed as a string.

`/* readonly / / optional */ pfcFeatureGroup`	`Group`
	The group, if the feature is a member of a group. Otherwise this will be `null`.

`/* readonly / / optional */ pfcFeatureGroup`	`GroupDirectHeader`


`/* readonly / / optional */ pfcGroupPattern`	`GroupPattern`
	The group pattern, if the feature is a member of a group pattern. Otherwise this will be `null`.

`/* readonly */ pfcGroupPatternStatus`	`GroupPatternStatus`
	The group pattern status.

`/* readonly */ pfcGroupStatus`	`GroupStatus`
	The group status.

`/* readonly */ boolean`	`IsEmbedded`
	A Boolean flag that specifies whether the feature is an embedded datum or not.

`/* readonly */ boolean`	`IsGroupMember`
	Retrieves the group status of the specified feature.

`/* readonly */ boolean`	`IsReadonly`
	A Boolean flag that specifies whether the feature is read only

`/* readonly */ boolean`	`IsVisible`
	A Boolean flag that specifies whether the feature is visible.

`/* readonly / / optional */ number`	`Number`
	The regeneration number of the feature. If the feature is suppressed or unregenerated, this will be `null`.

`/* readonly / / optional */ pfcFeaturePattern`	`Pattern`
	The pattern, if the feature is a member of a pattern. Otherwise this will be `null`. This function should only be used for simple patttern and use GetPatternByType function for nested pattern.

`/* readonly */ pfcPatternStatus`	`PatternStatus`
	The pattern status.

`/* readonly */ pfcFeatureStatus`	`Status`
	The feature status.

`/* readonly */ string`	`VersionStamp`
	The version stamp

Method Summary


`pfcDeleteOperation`	`CreateDeleteOp ()`
	Creates a feature delete operation.

`pfcReorderAfterOperation`	`CreateReorderAfterOp (pfcFeature AfterFeat)`
	Creates an operation that will reorder the features after the specified feature.

`pfcReorderBeforeOperation`	`CreateReorderBeforeOp (pfcFeature BeforeFeat)`
	Creates an operation that will reorder the features before the specified feature.

`pfcResumeOperation`	`CreateResumeOp ()`
	Creates a new resume operation object.

`pfcSuppressOperation`	`CreateSuppressOp ()`
	Creates a new suppress operation object.

`/* optional */ pfcFeaturePattern`	`GetPatternByType (pfcPatternType Type)`


`pfcFeatures`	`ListChildren ()`
	Lists the children of the feature.

`pfcFeatures`	`ListParents ()`
	Lists the parents of the feature.

`/* optional */ pfcModelItems`	`ListSubItems ( /* optional */ pfcModelItemType Type)`
	Lists the component model items that make up the feature.

Property Detail

/* readonly */ string FeatSubType

The feature subtype, i.e. "Extrude" or "Revolve" for a protrusion.

/* readonly */ pfcFeatureType FeatType

The feature type.

/* readonly */ string FeatTypeName

The feature type expressed as a string.

/* readonly */ /* optional */ pfcFeatureGroup Group

The group, if the feature is a member of a group. Otherwise this will be null.

/* readonly */ /* optional */ pfcFeatureGroup GroupDirectHeader

/* readonly */ /* optional */ pfcGroupPattern GroupPattern

The group pattern, if the feature is a member of a group pattern. Otherwise this will be null.

/* readonly */ pfcGroupPatternStatus GroupPatternStatus

The group pattern status.

/* readonly */ pfcGroupStatus GroupStatus

The group status.

/* readonly */ boolean IsEmbedded

A Boolean flag that specifies whether the feature is an embedded datum or not.

/* readonly */ boolean IsGroupMember

Retrieves the group status of the specified feature.

/* readonly */ boolean IsReadonly

A Boolean flag that specifies whether the feature is read only

/* readonly */ boolean IsVisible

A Boolean flag that specifies whether the feature is visible.

This flag distinguishes visible features from internal features. Internal features are invisible features used for construction purposes.

/* readonly */ /* optional */ number Number

The regeneration number of the feature. If the feature is suppressed or unregenerated, this will be null.

/* readonly */ /* optional */ pfcFeaturePattern Pattern

The pattern, if the feature is a member of a pattern. Otherwise this will be null. This function should only be used for simple patttern and use GetPatternByType function for nested pattern.

/* readonly */ pfcPatternStatus PatternStatus

The pattern status.

/* readonly */ pfcFeatureStatus Status

The feature status.

/* readonly */ string VersionStamp

The version stamp

Method Detail

pfcDeleteOperation CreateDeleteOp ()

Creates a feature delete operation.

The return value must be passed as a member of a pfcFeatureOperations sequence to the method pfcSolid.ExecuteFeatureOps() .

Returns:: The deletion operation

pfcReorderAfterOperation CreateReorderAfterOp (pfcFeature AfterFeat)

Creates an operation that will reorder the features after the specified feature.

The return value must be passed as a member of a pfcFeatureOperations sequence to the method pfcSolid.ExecuteFeatureOps() .

Parameters:

AfterFeat: The feature after which you want to reorder the features

Returns:: The new ReorderAfterOperation object

pfcReorderBeforeOperation CreateReorderBeforeOp (pfcFeature BeforeFeat)

Creates an operation that will reorder the features before the specified feature.

The return value must be passed as a member of a pfcFeatureOperations sequence to the method pfcSolid.ExecuteFeatureOps() .

Parameters:

BeforeFeat: The feature before which you want to reorder the features

Returns:: The new ReorderBeforeOperation object

pfcResumeOperation CreateResumeOp ()

Creates a new resume operation object.

The return value must be passed as a member of a pfcFeatureOperations sequence to the method pfcSolid.ExecuteFeatureOps() .

Returns:: The new resume operation object

pfcSuppressOperation CreateSuppressOp ()

Creates a new suppress operation object.

The return value must be passed as a member of a pfcFeatureOperations sequence to the method pfcSolid.ExecuteFeatureOps() .

Returns:: The new suppress operation object

/* optional */ pfcFeaturePattern GetPatternByType (pfcPatternType Type)

Parameters:

Type

Returns:

pfcFeatures ListChildren ()

Lists the children of the feature.

Returns:: The list of first-generation children features.

pfcFeatures ListParents ()

Lists the parents of the feature.

Returns:: The list of first-generation parents features.

/* optional */ pfcModelItems ListSubItems ( /* optional */ pfcModelItemType Type)

Lists the component model items that make up the feature.

Following are the subitems that can get listed with this method: ITEM_SURFACE, ITEM_EDGE, ITEM_QUILT, ITEM_CURVE, ITEM_POINT, ITEM_AXIS, ITEM_COORD_SYS and ITEM_DIMENSION.

Parameters:

Type: The type of subitem you want to find

Returns:: The list of subitems of the specified type