CIP JAVA documentation for class "com.ptc.wfc.wfcXSection.WXSection"

Interface WXSection

package com.ptc.wfc.wfcXSection; public interface WXSection extends com.ptc.wfc.wfcModelItem.WModelItem, com.ptc.wfc.wfcLayerState.LayerItem, com.ptc.pfc.pfcXSection.XSection

Description

Adds more functionality to XSection 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.

Method Summary
`/optional/ XSectionCutComponents`	`CollectCutComponents ( /optional/ View2D 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/ XSectionGeometries`	`CollectGeometry ( /optional/ View2D DrawingView)` `DEPRECATED: <incorrect deprecated ref>` `SUCCESSOR(S): WXSection.CollectCutComponents` Retrieves the geometry of non-empty cross-section components (intersecting their sub-assemblies)
`/optional/ XSectionComponents`	`GetComponents ()` `DEPRECATED: <incorrect deprecated ref>` `SUCCESSOR(S): <reference 1 to unknown entity >` Gets componets which are included or excluded from cross section definition
`/optional/ XSectionHatches`	`GetCompXSectionHatches (int XSecCompId, /optional/ View2D DrawingView)` `DEPRECATED: <incorrect deprecated ref>` `SUCCESSOR(S): XSectionCutComponentItem.GetXHatchStyle, XSectionCutComponent.GetXHatchStyle` Gets line patterns in cross section
`/optional/ XSectionExcludeItems`	`GetExcludedItems ()` Returns object containing excluded/included components and bodies and their excluded/included status.
`/optional/ Feature`	`GetFeature ()` Returns feature representing cross section. Method should be called only if `WModel.CanCreateSectionFeature()` returns true
`boolean`	`GetFlip ()` Gets model clipping direction
`MassProperty`	`GetMassProperty (String CsysName)` Mass Property related information. Only following methods should be called on this `MassProperty` object `MassProperty.GetSurfaceArea(double)` `MassProperty.GetGravityCenter(Point3D)` `MassProperty.GetCoordSysInertia(Inertia)`
`String`	`GetName ()` Returns name of the cross section
`OffsetXSectionData`	`GetOffsetXSectionData ( /optional/ View2D DrawingView)` Get parameters of offset cross section
`Surface`	`GetPlane ()` Returns the plane of a given Cross Section.
`boolean`	`IsFeature ()` Determines if cross section is feature
`void`	`SetCompXSectionHatches (int XSecCompId, /optional/ View2D DrawingView, /optional/ XSectionHatches Hatches)` `DEPRECATED: <incorrect deprecated ref>` `SUCCESSOR(S): XSectionCutComponentItem.SetXHatchStyle, XSectionCutComponent.SetXHatchStyle` Sets line patterns on cross section component
`void`	`SetName (String XSectionName)` Renames the cross 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.pfcObject.Child`
`GetDBParent`, `GetOId`

Methods Inherited from Interface `com.ptc.pfc.pfcModelItem.ModelItem`
`GetName`, `SetName`, `GetId`, `GetType`

Methods Inherited from Interface `com.ptc.wfc.wfcModelItem.WModelItem`
`DeleteUserDefinedName`, `Unhide`, `Hide`, `IsHidden`, `IsNameReadOnly`, `IsZoneFeature`, `GetDefaultName`

Methods Inherited from Interface `com.ptc.wfc.wfcLayerState.LayerItem`
`IsLayerItemVisible`, `RemoveNoUpdate`, `GetLayers`, `AddNoUpdate`

Methods Inherited from Interface `com.ptc.pfc.pfcXSection.XSection`
`GetName`, `SetName`, `GetXSecType`, `Delete`, `Display`, `Regenerate`

Method Detail

SetCompXSectionHatches

void SetCompXSectionHatches (int XSecCompId, /*optional*/ View2D DrawingView, /*optional*/ XSectionHatches Hatches)

DEPRECATED: <incorrect deprecated ref>
SUCCESSOR(S): XSectionCutComponentItem.SetXHatchStyle, XSectionCutComponent.SetXHatchStyle

Sets line patterns on cross section component

Exceptions thrown (but not limited to):

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

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

XToolkitEmpty - 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 XSectionHatch

Returns:

GetCompXSectionHatches

/*optional*/ XSectionHatches GetCompXSectionHatches (int XSecCompId, /*optional*/ View2D DrawingView)

DEPRECATED: <incorrect deprecated ref>
SUCCESSOR(S): XSectionCutComponentItem.GetXHatchStyle, XSectionCutComponent.GetXHatchStyle

Gets line patterns in cross section

Exceptions thrown (but not limited to):

XToolkitNotFound - 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:: XSectionHatches object

GetFeature

/*optional*/ Feature GetFeature ()

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

Exceptions thrown (but not limited to):

XToolkitBadContext - Legacy cross sections.

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

Returns:: Feature

GetMassProperty

MassProperty GetMassProperty (String CsysName)

Mass Property related information. Only following methods should be called on this MassProperty object
MassProperty.GetSurfaceArea(double)
MassProperty.GetGravityCenter(Point3D)
MassProperty.GetCoordSysInertia(Inertia)

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

Parameters:

CsysName: Name of the CSYS

Returns:: MassProperty object

CollectGeometry

/*optional*/ XSectionGeometries CollectGeometry ( /*optional*/ View2D DrawingView)

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

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

Exceptions thrown (but not limited to):

XToolkitNotFound - 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:: XSectionGeometries object

CollectCutComponents

/*optional*/ XSectionCutComponents CollectCutComponents ( /*optional*/ View2D 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.

GetPlane

Surface GetPlane ()

Returns the plane of a given Cross Section.

Exceptions thrown (but not limited to):

XToolkitNotImplemented - This is not a planar cross-section.

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

Returns:: Surface object

IsFeature

boolean 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

GetOffsetXSectionData

OffsetXSectionData GetOffsetXSectionData ( /*optional*/ View2D DrawingView)

Get parameters of offset cross section

Exceptions thrown (but not limited to):

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

GetName

String 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

SetName

void SetName (String XSectionName)

Renames the cross section

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

Parameters:

XSectionName

Returns:

GetFlip

boolean 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

GetComponents

/*optional*/ XSectionComponents GetComponents ()

DEPRECATED: <incorrect deprecated ref>
SUCCESSOR(S): <reference 1 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:: XSectionComponents object

GetExcludedItems

/*optional*/ XSectionExcludeItems 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