CIP C++ documentation for class "wfcWXSection"

Class wfcWXSection

# include <wfcXSection.h> class wfcWXSection : public virtual wfcWModelItem, : public virtual wfcLayerItem, : public virtual pfcXSection { xaideclare(wfcWXSection) ... };

Description

Adds more functionality to pfcXSection as indicated below. This interface adds method for adding line pattern hathching on cross section. It also provides methods to get mass properties ,feature representation and geometry of cross section.

Manual References:: Overview of Creo Object TOOLKIT C++: Casting of Creo Object TOOLKIT C++ pfc Classes to wfc Classes

Method Summary


`optional wfcXSectionCutComponents_ptr`	`CollectCutComponents (optional pfcView2D_ptr DrawingView)`
	Returns sequence of XSectionCutComponent objects. A sequence item is created for each body. If no bodies are created, contains one XSectionCutComponent for each component.

`optional wfcXSectionGeometries_ptr`	`CollectGeometry (optional pfcView2D_ptr DrawingView)`
	`DEPRECATED: <incorrect deprecated ref>` `SUCCESSOR(S): wfcWXSection::CollectCutComponents` Retrieves the geometry of non-empty cross-section components (intersecting their sub-assemblies)

`optional wfcXSectionComponents_ptr`	`GetComponents ()`
	`DEPRECATED: <incorrect deprecated ref>` `SUCCESSOR(S): <reference 3 to unknown entity >` Gets componets which are included or excluded from cross section definition

`optional wfcXSectionHatches_ptr`	`GetCompXSectionHatches (xint XSecCompId, optional pfcView2D_ptr DrawingView)`
	`DEPRECATED: <incorrect deprecated ref>` `SUCCESSOR(S): wfcXSectionCutComponentItem::GetXHatchStyle, wfcXSectionCutComponent::GetXHatchStyle` Gets line patterns in cross section

`optional wfcXSectionExcludeItems_ptr`	`GetExcludedItems ()`
	Returns object containing excluded/included components and bodies and their excluded/included status.

`optional pfcFeature_ptr`	`GetFeature ()`
	Returns feature representing cross section. Method should be called only if `wfcWModel::CanCreateSectionFeature()` returns true

`xbool`	`GetFlip ()`
	Gets model clipping direction

`pfcMassProperty_ptr`	`GetMassProperty (xrstring CsysName)`
	Mass Property related information. Only following methods should be called on this `pfcMassProperty` object `pfcMassProperty::GetSurfaceArea(xreal)` `pfcMassProperty::GetGravityCenter(pfcPoint3D_ptr)` `pfcMassProperty::GetCoordSysInertia(pfcInertia_ptr)`

`xstring`	`GetName ()`
	Returns name of the cross section

`wfcOffsetXSectionData_ptr`	`GetOffsetXSectionData (optional pfcView2D_ptr DrawingView)`
	Get parameters of offset cross section

`pfcSurface_ptr`	`GetPlane ()`
	Returns the plane of a given Cross Section.

`xbool`	`IsFeature ()`
	Determines if cross section is feature

`void`	`SetCompXSectionHatches (xint XSecCompId, optional pfcView2D_ptr DrawingView, optional wfcXSectionHatches_ptr Hatches)`
	`DEPRECATED: <incorrect deprecated ref>` `SUCCESSOR(S): wfcXSectionCutComponentItem::SetXHatchStyle, wfcXSectionCutComponent::SetXHatchStyle` Sets line patterns on cross section component

`void`	`SetName (xrstring XSectionName)`
	Renames the cross 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 pfcChild:: GetDBParent, GetOId

Methods Inherited from Class pfcModelItem:: GetName, SetName, GetId, GetType

Methods Inherited from Class wfcWModelItem:: DeleteUserDefinedName, Unhide, Hide, IsHidden, IsNameReadOnly, IsZoneFeature, GetDefaultName

Methods Inherited from Class wfcLayerItem:: IsLayerItemVisible, RemoveNoUpdate, GetLayers, AddNoUpdate

Methods Inherited from Class pfcXSection:: GetName, SetName, GetXSecType, Delete, Display, Regenerate

Method Detail

void SetCompXSectionHatches (xint XSecCompId, optional pfcView2D_ptr DrawingView, optional wfcXSectionHatches_ptr Hatches)

DEPRECATED: <incorrect deprecated ref>
SUCCESSOR(S): wfcXSectionCutComponentItem::SetXHatchStyle, wfcXSectionCutComponent::SetXHatchStyle

Sets line patterns on cross section component

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - Input cross-section is not a drawing view cross-section or doesn't have the component with given id that is inside the view.

pfcXToolkitFound - Cross-section component already has the input line pattern. Nothing added.

pfcXToolkitEmpty - Empty sequence of line patterns.

Manual References:: Cross Sections: Line Patterns of Cross Section Components, Cross Sections: Line Patterns of Cross Section Components

Parameters:

XSecCompId: Component identifier being cut by cross section
DrawingView: View object if not null, in component list we have only solid geometry (non-quilt and non-facetrep) components that intersect their non-hidden, non-suppressed parts and are inside view borders; if null in component list we have all non-empty components
Hatches: Line Patterns on cross section. Pass sequence of wfcXSectionHatch

Returns:

optional wfcXSectionHatches_ptr GetCompXSectionHatches (xint XSecCompId, optional pfcView2D_ptr DrawingView)

DEPRECATED: <incorrect deprecated ref>
SUCCESSOR(S): wfcXSectionCutComponentItem::GetXHatchStyle, wfcXSectionCutComponent::GetXHatchStyle

Gets line patterns in cross section

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - Input cross-section is not a drawing view cross-section or doesn't have the component with given id that is inside the view or the component doesn't have xhatches.

Manual References:: Cross Sections: Line Patterns of Cross Section Components, Cross Sections: Line Patterns of Cross Section Components

Parameters:

XSecCompId: Component identifier being cut by cross section
DrawingView: View object if not null, in component list we have only solid geometry (non-quilt and non-facetrep) components that intersect their non-hidden, non-suppressed parts and are inside view borders; if null in component list we have all non-empty components

Returns:: wfcXSectionHatches object

optional pfcFeature_ptr GetFeature ()

Returns feature representing cross section. Method should be called only if wfcWModel::CanCreateSectionFeature() returns true

Exceptions thrown (but not limited to):

pfcXToolkitBadContext - Legacy cross sections.

Manual References:: Cross Sections: Creating and Modifying Cross Sections, Cross Sections: Creating and Modifying Cross Sections

Returns:: pfcFeature

pfcMassProperty_ptr GetMassProperty (xrstring CsysName)

Mass Property related information. Only following methods should be called on this pfcMassProperty object
pfcMassProperty::GetSurfaceArea(xreal)
pfcMassProperty::GetGravityCenter(pfcPoint3D_ptr)
pfcMassProperty::GetCoordSysInertia(pfcInertia_ptr)

Manual References:: Cross Sections: Mass Properties of Cross Sections

Parameters:

CsysName: Name of the CSYS

Returns:: pfcMassProperty object

optional wfcXSectionGeometries_ptr CollectGeometry (optional pfcView2D_ptr DrawingView)

DEPRECATED: <incorrect deprecated ref>
SUCCESSOR(S): wfcWXSection::CollectCutComponents

Retrieves the geometry of non-empty cross-section components (intersecting their sub-assemblies)

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - Input cross-section is not a drawing view cross-section.

Manual References:: Cross Sections: Extracting Cross-Sectional Geometry

Parameters:

DrawingView: View object if not null, in component list we have only solid geometry (non-quilt and non-facetrep) components that intersect their non-hidden, non-suppressed parts and are inside view borders; if null in component list we have all non-empty components

Returns:: wfcXSectionGeometries object

optional wfcXSectionCutComponents_ptr CollectCutComponents (optional pfcView2D_ptr DrawingView)

Returns sequence of XSectionCutComponent objects. A sequence item is created for each body. If no bodies are created, contains one XSectionCutComponent for each component.

Manual References:: Cross Sections: Extracting Cross-Sectional Geometry, Cross Sections: Extracting Cross-Sectional Geometry

Parameters:

DrawingView: The drawing view. This method returns only items containing solid geometry (non-quilt and non-facetrep) components that intersect their non-hidden, non-suppressed parts and are inside view borders; If null, returns all non-empty components.

Returns:: The XSectionCutComponents object.

pfcSurface_ptr GetPlane ()

Returns the plane of a given Cross Section.

Exceptions thrown (but not limited to):

pfcXToolkitNotImplemented - This is not a planar cross-section.

Manual References:: Cross Sections: Extracting Cross-Sectional Geometry, Cross Sections: Extracting Cross-Sectional Geometry

Returns:: pfcSurface object

xbool IsFeature ()

Determines if cross section is feature

Manual References:: Cross Sections: Creating and Modifying Cross Sections, Cross Sections: Creating and Modifying Cross Sections

Returns:: If true cross section is a feature

wfcOffsetXSectionData_ptr GetOffsetXSectionData (optional pfcView2D_ptr DrawingView)

Get parameters of offset cross section

Exceptions thrown (but not limited to):

pfcXToolkitNotImplemented - Some of X-section entities is not a line segment.

Manual References:: Cross Sections: Extracting Cross-Sectional Geometry, Cross Sections: Extracting Cross-Sectional Geometry

Parameters:

DrawingView: View object if not null, in component list we have only solid geometry (non-quilt and non-facetrep) components that intersect their non-hidden, non-suppressed parts and are inside view borders; if null in component list we have all non-empty components

Returns:

xstring GetName ()

Returns name of the cross section

Manual References:: Cross Sections: Extracting Cross-Sectional Geometry, Cross Sections: Extracting Cross-Sectional Geometry

Returns:: Cross section name

void SetName (xrstring XSectionName)

Renames the cross section

Manual References:: Cross Sections: Extracting Cross-Sectional Geometry, Cross Sections: Extracting Cross-Sectional Geometry

Parameters:

XSectionName

Returns:

xbool GetFlip ()

Gets model clipping direction

Manual References:: Cross Sections: Extracting Cross-Sectional Geometry, Cross Sections: Extracting Cross-Sectional Geometry

Returns:: If true model is clipped in the direction of the positive normal to the cross section plane otherwise in the direction of negative normal of cross section plane

optional wfcXSectionComponents_ptr GetComponents ()

DEPRECATED: <incorrect deprecated ref>
SUCCESSOR(S): <reference 3 to unknown entity >

Gets componets which are included or excluded from cross section definition

Manual References:: Cross Sections: Extracting Cross-Sectional Geometry, Cross Sections: Extracting Cross-Sectional Geometry

Returns:: wfcXSectionComponents object

optional wfcXSectionExcludeItems_ptr GetExcludedItems ()

Returns object containing excluded/included components and bodies and their excluded/included status.

Manual References:: Cross Sections: Extracting Cross-Sectional Geometry, Cross Sections: Extracting Cross-Sectional Geometry

Returns:: The XSectionExcludeItems object