Library | Package Java Toolkit

Interface WSolid

package com.ptc.wfc.wfcSolid;

public interface WSolid
  extends com.ptc.wfc.wfcModel.WModel,
          com.ptc.wfc.wfcFamily.WFamilyMember,
          com.ptc.pfc.pfcSolid.Solid



Description

Adds more methods to Solid as indicated below.

This interface adds methods for fine-tuned feature regeneration, as well as for feature deleting, suppressing, resuming and reordering. It also allows creating features using Feature Element Tree.

Note:Object TOOLKIT uses the same constants for defining Feature Element Trees as Creo Parametric TOOLKIT does. For specific constants describing specific feature types please refer to Creo Parametric TOOLKIT documentation and header files.


Direct Known Subclasses:
WPart, WAssembly



Method Summary
voidActivateAutomaticSimpRep (SimpRep SimpRep)
    Activate user-defined rep as automatic simplified rep.
voidActivateCombState (CombState CombState)
    Activates a combined state
voidActivateStyleState (StyleState WStyleState, boolean RedisplayFlag)
    Activates the style state
FamilyTableStatusCheckFamilyTable ()
     Determines whether the specified solid has a family table, and if that family table is valid and/or empty.
voidCollapseDetailTree ( /*optional*/ Window SolidWindow)
    Collapse the tree for the solid in the window.
/*optional*/ CollectionCollectCurves (ChainCollectionUIControls ChainControls, /*optional*/ CollectCurvesFilter FilterMethod, /*optional*/ Object AppData, /*optional*/ CurveCollection AppendColl)
    Asks the user to interactively create a collection of chains
/*optional*/ CollectionCollectSurfaces (SurfaceCollectionInstrTypes InstrTypes, /*optional*/ CollectSurfacesFilter FilterMethod, /*optional*/ SurfaceCollection AppendColl)
    Asks the user to interactively create a collection of surfaces
voidConvertAutomaticSimpRep (SimpRep SimpRep)
    Convert user-defined rep to new automatic simplified rep preserving excluded/substituted data.
AnnotationFeatureCreateAnnotationFeature ( /*optional*/ ComponentPath CompPath, boolean InvokeUI)
LICENSE: 222
    Creates a new annotation feature in the model.
AnnotationPlaneCreateAnnotationPlaneFromView (String ViewName)
     
WSolidBodyCreateBody ()
    Create a new body in solid.
CombStateCreateCombState (String CombStateName, CombStateData CombStateData)
    Create combined state
WFeatureCreateCustomFeature (String CustomFeatXmlFile, String ElemTreeXmlFile, FeatCreateOptions Options, /*optional*/ WRegenInstructions Instrs)
     Create custom feature
DimensionCreateDimension (AnnotationPlane AnnotPlane, DimensionAttachments DimAttachs, DimSenses Senses, DimOrientationHint OrientHint, Point3D Location)
LICENSE: 222
     
AnnotationPlaneCreateFlatToScreenPlane (boolean ScreenOrMdlPoint)
     
DetailNoteItemCreateFreeNote (DetailTextLines TextLines, FreeAttachment Attach)
     
LayerStateCreateLayerState (LayerStateData LayerStateData)
    Create Layer state from references.
DetailNoteItemCreateLeaderNote (DetailTextLines TextLines, Attachment NoteAttach, DetailLeaderAttachments LeadrAttachs)
     
DetailNoteItemCreateLeaderWithArrowTypeNote (DetailTextLines TextLines, Attachment NoteAttach, DetailLeaderAttachments LeadrAttachs, AnnotationPlane AnnotPlane, LeaderArrowTypes Types)
LICENSE: 222
     
DetailNoteItemCreateOnItemNote (DetailTextLines TextLines, AnnotationPlane AnnotPlane, ParametricAttachment Attach)
LICENSE: 222
     
WDimensionCreateOrdinateDimension (AnnotationType AnnotType, AnnotationElement AnnotationElement, DimensionAttachment DimAttach, DimSenses Senses, DimOrientationHint OrientHint, Point3D Location)
LICENSE: 222
     
WXSectionCreateParallelXSection (String Name, int PlaneId, double Distance)
     Create a Cross Section parallel to a given plane.
WXSectionCreatePlanarXSection (String Name, int PlaneId, XSecCutobjType CutObjectType, /*optional*/ intseq MemberIdTable, int QuiltId, boolean Flip, /*optional*/ XSectionComponents XSecModels)
DEPRECATED: <incorrect deprecated ref>
SUCCESSOR(S): WSolid.CreatePlanarXSectionWithOptions

     Create a Cross Section through a datum plane.
WXSectionCreatePlanarXSectionWithOptions (String Name, Selection Plane, XSecCutobjType CutObjectType, /*optional*/ Selection QuiltOrPart, boolean Flip, /*optional*/ XSectionExcludeItems ExcludeItems, /*optional*/ XSectionCreateData Data)
     
DimensionCreateRefDimension (AnnotationPlane AnnotPlane, DimensionAttachments DimAttachs, DimSenses Senses, DimOrientationHint OrientHint, Point3D Location)
LICENSE: 222
     
DetailSymbolDefItemCreateSymbolDefinition (DetailSymbolDefInstructions Instructions)
     
DetailSymbolInstItemCreateSymbolInstance (DetailSymbolInstInstructions Instructions, AnnotationPlane AnnotPlane)
LICENSE: 222
     
WFeatureCreateZoneSectionFeature (ZoneFeatureReferences RefData, String ZoneName)
     Creates a Zone feature.
voidDeleteBody (WSolidBody Body)
    Deletes the specified body in solid.
voidDeleteCombState (CombState CombState)
    Deletes a combined state
voidDeleteFeatures (intseq FeatIDs, FeatSuppressOrDeleteOptions Options, /*optional*/ WRegenInstructions Instrs)
    Deletes a list of features.
voidDisplaySolid ()
    Displays the specified object.
voidExpandDetailTree ( /*optional*/ Window SolidWindow)
    Expand the tree for the solid in the window.
ShellDataFindShellsAndVoids ()
     For each shell and void of solid, returns surface-contour pairs which describe them.
CombStateGetActiveCombState ()
    Gets the active combined state in solid
LayerStateGetActiveLayerState ()
    Get active layer state on a model.
StyleStateGetActiveStyleState ()
    Returns the current active style state
/*optional*/ ItemAppearanceAndTexturesSeqGetAllAppearancesAndTextures ()
    Gets the appearance properties, texture placement properties and texture properties applied on a model. These may not be the properties that are currently visible on the model because they may be overriden by other higher level color application.
CombStateAnnotationsGetAnnotationsOfActiveState ()
    Gets annotations of active combined state
WAxisGetAxis (int AxisId)
    Initializes the Axis handle
WCsysGetCsys (int CsysId)
    >Returns Csys handle
WCurveGetCurve (int CurveId)
    Returns curve handle
doubleGetDefaultTextHeight ()
     Obtains the default text height used for text in annotations and dimensions in the solid model.
Outline3DGetDisplayOutline (Matrix3D Matrix)
    Computes the display outline of a solid.
WEdgeGetEdge (int EdgeId)
     Returns Edge handle
booleanGetIsNoResolveMode ()
    Get method for attribute "IsNoResolveMode"
    Returns true if the model regeneration is set to "no resolve mode"; false otherwise.
ModelClassGetModelClass ()
    Gets the ISO/DIN model class type for a solid model.
WPointGetPoint (int PointId)
     Returns Point handle
WQuiltGetQuilt (int QuiltId)
     Returns Quilt handle
FeatureStatusFlagsGetSolidFeatureStatusFlags ()
    Returns the list of objects representing the status of each feature in the model.
StyleStateGetStyleStateFromId (int StyleStateId)
    >Returns the handle to the specified style state
StyleStateGetStyleStateFromName (String StyleStateName)
    Returns the handle to the specified style state
doubleGetTolerance (ToleranceType Type, int Decimals)
    Retreives the tolerance value for the specified solid, for the specified number of decimal places.
FeatureImportAsFeat (IntfDataSource IntfData, /*optional*/ CoordSystem CoordSys, /*optional*/ Boolean CutOrAdd, /*optional*/ String Profile, /*optional*/ Boolean DatumCurve)
    Creates a new import feature in the solid (part). Assembly case is not supported.
/*optional*/ FeaturesListChildOfExternalFailedFeatures ()
    Returns a list, each element of which is a child of an external failed feature.
/*optional*/ FeaturesListChildOfFailedFeatures ()
    Returns a list, each element of which is a child of a failed feature.
CombStatesListCombStates ()
    Returns list of combined states of a solid
/*optional*/ DetailItemsListDetailItems ( /*optional*/ DetailType Type)
     
LayerStatesListLayerStates ()
    Gets Layer state list.
StyleStatesListStyleStateItems ()
    Returns list of style state in the solid
voidLoadToleranceClass (String ToleranceClassName)
    This will load a tolerance class for Hole or Shaft ISO tols.
ProjectionInfoProjectPoint (Point3D Point, double Tolerance)
     finds a surface from the solid within the maximum distance, and returns the UV point of the projection of the point to that surface.
voidQuickPrint ( /*optional*/ QuickPrintInstructions Instructions, /*optional*/ String PFCFile)
    Executes a quick print of a given solid model.
voidRefreshDetailTree ( /*optional*/ Window SolidWindow)
    Rebuild the tree for the solid in the window.
voidReorderFeatures (intseq FeatIDs, int NewFeatNum, /*optional*/ WRegenInstructions Instrs)
    Reorders a list of features.
voidResumeFeatures (intseq FeatIDs, FeatResumeOptions Options, /*optional*/ WRegenInstructions Instrs)
    Resumes a list of features.
DetailSymbolDefItemRetrieveSymbolDefItem (String FileName, DetailSymbolDefItemSource Source, /*optional*/ String FilePath, /*optional*/ Integer Version, /*optional*/ Boolean UpdateUnconditionally)
LICENSE: 222
    Retrieve a symbol definition.
voidSetModelClass (ModelClass ModelClass)
    Sets the ISO/DIN model class type for a solid model.
voidSetTolerance (ToleranceType Type, int Decimals, double Tolerance)
    Sets the solid's tolerance, at the specified number of decimal places, to the specified value.
voidSuppressFeatures (intseq FeatIDs, FeatSuppressOrDeleteOptions Options, /*optional*/ WRegenInstructions Instrs)
    Suppresses a list of features.
SurfaceTessellationDataSeqTessellate (double ChordHeight, double AngleControl, boolean IncludeQuilts)
     
voidUpdateActiveLayerState ()
    Update active layer state.
WFeatureWCreateFeature (ElementTree Tree, FeatCreateOptions Options, /*optional*/ WRegenInstructions Instrs)
    Creates a feature from the Feature Element Tree
voidWRegenerate ( /*optional*/ WRegenInstructions Instrs)
    Regenerates the model accoding to provided instructions.

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.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.pfc.pfcFamily.FamilyMember
GetParent, GetImmediateGenericInfo, GetTopGenericInfo, ListColumns, ListRows, GetCell, SetCell, GetCellIsDefault, AddRow, GetRow, RemoveRow, AddColumn, RemoveColumn, GetColumn, CreateColumn, CreateParamColumn, CreateDimensionColumn, CreateFeatureColumn, CreateComponentColumn, CreateCompModelColumn, CreateGroupColumn, CreateMergePartColumn, CreateTolPlusColumn, CreateTolMinusColumn, CreateTolPlusMinusColumn

Methods Inherited from Interface com.ptc.wfc.wfcFamily.WFamilyMember
SelectRows, GetFamilyTableStatus, IsModifiable, EditFamilyTable, EraseFamilyTable, ShowFamilyTable

Methods Inherited from Interface com.ptc.pfc.pfcSolid.Solid
GetDefaultBody, GetSurfaceSolidBody, GetEdgeSolidBody, GetGeomOutline, GetRelativeAccuracy, SetRelativeAccuracy, GetAbsoluteAccuracy, SetAbsoluteAccuracy, Regenerate, ExecuteFeatureOps, EvalOutline, CreateLocalGroup, CreateNote, ListFailedFeatures, ListFeaturesByType, ListCrossSections, GetCrossSection, GetIsSkeleton, HasRetrievalErrors, GetFeatureByName, GetFeatureById, CreateImportFeat, ActivateSimpRep, GetActiveSimpRep, CreateSimpRep, SelectSimpRep, GetSimpRep, GetMasterRep, GetGraphicsRep, GetGeomRep, DeleteSimpRep, GetMassProperty, GetMassPropertyWithDensity, ListGroups, CreateFeature, CreateUDFGroup, ExportShrinkwrap, GetPrincipalUnits, SetPrincipalUnits, ListUnits, ListUnitSystems, GetUnit, CreateCustomUnit, CreateUnitSystem

Method Detail

CreateBody

WSolidBodyCreateBody ()


    Create a new body in solid.
Manual References:
Solid Bodies: Creating a Solid Body, Solid Bodies: Creating a Solid Body
Returns:
The newly created solid body object.


DeleteBody

voidDeleteBody (WSolidBody Body)


    Deletes the specified body in solid.
Manual References:
Solid Bodies: Creating a Solid Body, Solid Bodies: Creating a Solid Body
Parameters:
Body
The body to delete.
Returns:
nothing


GetIsNoResolveMode

booleanGetIsNoResolveMode ()


    Returns true if the model regeneration is set to "no resolve mode"; false otherwise.
Manual References:
Solid: Solid Operations, Solid: Solid Operations



WRegenerate

voidWRegenerate ( /*optional*/ WRegenInstructions Instrs)


    Regenerates the model accoding to provided instructions.

This method generates XToolkitRegenerateAgain if the model is too complex to regenerate the first time.
Manual References:
Solid: Regenerating a Solid, Solid: Regenerating a Solid
Parameters:
Instrs
Regeneration instructions to be used.
Returns:
nothing


ListChildOfFailedFeatures

/*optional*/ FeaturesListChildOfFailedFeatures ()


    Returns a list, each element of which is a child of a failed feature.

If no such feature found, returns NULL
Manual References:
Features: Access to Features, Features: Access to Features
Returns:
A list of requested features.


ListChildOfExternalFailedFeatures

/*optional*/ FeaturesListChildOfExternalFailedFeatures ()


    Returns a list, each element of which is a child of an external failed feature.

If no such feature found, returns NULL
Manual References:
Features: Access to Features, Features: Access to Features
Returns:
A list of requested features.


GetSolidFeatureStatusFlags

FeatureStatusFlagsGetSolidFeatureStatusFlags ()


    Returns the list of objects representing the status of each feature in the model.
Manual References:
Solid: Solid Operations, Solid: Solid Operations
Returns:
The list of feature status flags.


WCreateFeature

WFeatureWCreateFeature (ElementTree Tree, FeatCreateOptions Options, /*optional*/ WRegenInstructions Instrs)


    Creates a feature from the Feature Element Tree

Refer to the Release Notes for more information on restrictions of using this function with Multi-CAD models. This method cannot be used to create feature in component of the assembly. Use WSelection.CreateFeature(ElementTree, FeatCreateOptions, /*optional*/ WRegenInstructions) for creating feature in the component.
Manual References:
Feature Element Tree: Overview of Feature Creation, Feature Element Tree: Creating FET Using WCreateFeature, Feature Element Tree: Creating FET Using WCreateFeature, Element Trees: Sketched Features: Creating Features Containing Sections, Element Trees: Sketched Features: To Create Sketched Features Element Trees, Element Trees: Sketched Features: 3D Section Location in the Owning Model
Parameters:
Tree
The Feature Element Tree object.
Options
Options to create the feature.
Instrs
Regeneration instructions to be used.
Returns:
The object representing the feature.


DeleteFeatures

voidDeleteFeatures (intseq FeatIDs, FeatSuppressOrDeleteOptions Options, /*optional*/ WRegenInstructions Instrs)


    Deletes a list of features.
Manual References:
Features: Feature Operations, Features: Feature Operations
Parameters:
FeatIDs
The list of ids for features to be deleted.
Options
The list of options to be used.
Instrs
Regeneration instructions to be used.
Returns:
nothing


SuppressFeatures

voidSuppressFeatures (intseq FeatIDs, FeatSuppressOrDeleteOptions Options, /*optional*/ WRegenInstructions Instrs)


    Suppresses a list of features.
Manual References:
Features: Feature Operations, Features: Feature Operations
Parameters:
FeatIDs
The list of ids for features to be suppressed.
Options
The list of options to be used.
Instrs
Regeneration instructions to be used.
Returns:
nothing


ResumeFeatures

voidResumeFeatures (intseq FeatIDs, FeatResumeOptions Options, /*optional*/ WRegenInstructions Instrs)


    Resumes a list of features.

If the input feature list contains features that are already resumed, this method generates an exception and does not resume suppressed features.
Manual References:
Features: Feature Operations, Features: Feature Operations
Parameters:
FeatIDs
The list of ids for features to be resumed.
Options
The list of options to be used.
Instrs
Regeneration instructions to be used.
Returns:
nothing


ReorderFeatures

voidReorderFeatures (intseq FeatIDs, int NewFeatNum, /*optional*/ WRegenInstructions Instrs)


    Reorders a list of features.

This method reorders the list of features so that the location of the first feature will be NewFeatNum after the reorder. The list of feature ids must represent contiguous set of features in the model tree.

Note:If reordering a group, all the features in the group (including the Group Header feature) must be included in the list.


Manual References:
Features: Feature Operations
Parameters:
FeatIDs
The list of ids for features to be reordered.
NewFeatNum
The intended location of the first feature in the specified list.
Instrs
Regeneration instructions to be used.
Returns:
nothing


ImportAsFeat

FeatureImportAsFeat (IntfDataSource IntfData, /*optional*/ CoordSystem CoordSys, /*optional*/ Boolean CutOrAdd, /*optional*/ String Profile, /*optional*/ Boolean DatumCurve)


    Creates a new import feature in the solid (part). Assembly case is not supported.

Exceptions thrown (but not limited to):

XToolkitNoLicense - License check failure.

XToolkitInvalidFile - This means either:

  • The curve file doesn't have correct format, OR
  • The profile is not readable.

XToolkitInvalidFile - profile is not readable.

XToolkitUnsupported - Creo Parametric does not support import of the indicated file.

XToolkitNotExist - No profile found.


Manual References:
Interface: Solid Operations, Interface: Solid Operations, Interface: Creating Import Features from Files
Parameters:
IntfData
The source of data i.e. the file or interface dataWIntfNeutral from which to create the import feature.
CoordSys
A reference coordinate system. If NULL, the method uses the default coordinate system.
CutOrAdd
The attributes for imported geometry representing a cut or add operation in new import feature. If NULL, the method uses PRO_B_FALSE ie add as default operation.
Profile
Profile path that controls an import operation. Can be NULL.
DatumCurve
Attribute to import datum curve from input file. Can be NULL.
Returns:
The handle to the new import feature.Imported feature.


QuickPrint

voidQuickPrint ( /*optional*/ QuickPrintInstructions Instructions, /*optional*/ String PFCFile)


    Executes a quick print of a given solid model.

Exceptions thrown (but not limited to):

XToolkitNotFound - pcf_path is null, and no default plotter config file is set.

XToolkitNoPermission - The function does not have permission to operate on this model.

XToolkitBadContext - The function is not available in Design Test Mode.


Parameters:
Instructions
The instructions on how the quick print should be carried out.
PFCFile
Path to the plotter configuration file to use. If NULL, the value of the config option 'quickprint_plotter_config_file'
Returns:
nothing


CollectCurves

/*optional*/ CollectionCollectCurves (ChainCollectionUIControls ChainControls, /*optional*/ CollectCurvesFilter FilterMethod, /*optional*/ Object AppData, /*optional*/ CurveCollection AppendColl)


    Asks the user to interactively create a collection of chains

Exceptions thrown (but not limited to):

XToolkitUserAbort - The user aborted the collection activity.

XToolkitBadContext - The input ProCollection contains instructions that cannot be resolved into a single chain.


Manual References:
Curve and Surface Collection: Interactive Collection, Curve and Surface Collection: Interactive Collection
Parameters:
ChainControls
Array of control options defining which portion of the user interface will be allowed to use in the dialog.
FilterMethod
The Filter method CollectCurvesFilter.FilterSelections(Selection, /*optional*/ Object)called just after each selection of a curve or edge. Can be null.
AppData
Application data passed to the filter method
AppendColl
Collection to append into the details shown by the dialog.
Returns:
Collection object handle


CollectSurfaces

/*optional*/ CollectionCollectSurfaces (SurfaceCollectionInstrTypes InstrTypes, /*optional*/ CollectSurfacesFilter FilterMethod, /*optional*/ SurfaceCollection AppendColl)


    Asks the user to interactively create a collection of surfaces
Manual References:
Curve and Surface Collection: Interactive Collection
Parameters:
InstrTypes
Sequence defining the instruction types the Creo Parametric user will be allowed to use.
FilterMethod
The Filter method CollectSurfacesFilter.FilterSelections(/*optional*/ Selections, Selection) called just after each selection. Can be null.
AppendColl
Surface collection to append into the details shown by the dialog.
Returns:
Collection object handle


CreatePlanarXSection

WXSectionCreatePlanarXSection (String Name, int PlaneId, XSecCutobjType CutObjectType, /*optional*/ intseq MemberIdTable, int QuiltId, boolean Flip, /*optional*/ XSectionComponents XSecModels)

DEPRECATED: <incorrect deprecated ref>
SUCCESSOR(S): WSolid.CreatePlanarXSectionWithOptions


     Create a Cross Section through a datum plane.
See Also:
WXSection.SetCompXSectionHatches(int, /*optional*/ View2D, /*optional*/ XSectionHatches)
Manual References:
Cross Sections: Creating and Modifying Cross Sections
Parameters:
Name
Name of the Cross Section
PlaneId
Identifier of the plane or surface. Plane or Surface must belong to this solid
CutObjectType
Type of object being cut by the Cross Section.
MemberIdTable
Sequence of component identifiers when CutObjectType is pfcXSECTYPE_QUILTS or pfcXSECTYPE_ONEPART. Pass null in all other cases
QuiltId
Identifier of the quilt when CutObjectType is pfcXSECTYPE_QUILTS.Pass -1 in all other cases
Flip
Flip direction. If true model is clipped in the direction of the positive normal to the xsection plane otherwise in the direction of negative normal of xsection plane
XSecModels
XSectionComponents object specifying sequence of components to exclude or include from xsection definition.
Returns:
WXSection object


CreatePlanarXSectionWithOptions

WXSectionCreatePlanarXSectionWithOptions (String Name, Selection Plane, XSecCutobjType CutObjectType, /*optional*/ Selection QuiltOrPart, boolean Flip, /*optional*/ XSectionExcludeItems ExcludeItems, /*optional*/ XSectionCreateData Data)


     
Manual References:
Cross Sections: Creating and Modifying Cross Sections, Cross Sections: Creating and Modifying Cross Sections
Parameters:
Name
Plane
CutObjectType
QuiltOrPart
Flip
ExcludeItems
Data
Returns:


ListDetailItems

/*optional*/ DetailItemsListDetailItems ( /*optional*/ DetailType Type)


     
Parameters:
Type
Returns:


UpdateActiveLayerState

voidUpdateActiveLayerState ()


    Update active layer state.

Exceptions thrown (but not limited to):

XToolkitNotFound - No active layer state on the model.


Manual References:
ModelItem: Layer State
Returns:


CreateParallelXSection

WXSectionCreateParallelXSection (String Name, int PlaneId, double Distance)


     Create a Cross Section parallel to a given plane.

Exceptions thrown (but not limited to):

XToolkitFound - Cross section with such name already exists.


Manual References:
Cross Sections: Creating and Modifying Cross Sections, Cross Sections: Creating and Modifying Cross Sections
Parameters:
Name
Name of the Cross Section
PlaneId
Identifier of the plane
Distance
Offset distance from given plane
Returns:
WXSection object


ListCombStates

CombStatesListCombStates ()


    Returns list of combined states of a solid

Exceptions thrown (but not limited to):

XToolkitNotFound - No combined states found in the model.


Manual References:
Solid: Combined States of a Solid, Solid: Combined States of a Solid
Returns:
 


GetActiveCombState

CombStateGetActiveCombState ()


    Gets the active combined state in solid

Exceptions thrown (but not limited to):

XToolkitNotFound - No active combined state found.


Manual References:
Solid: Combined States of a Solid, Solid: Combined States of a Solid
Returns:
 


ActivateCombState

voidActivateCombState (CombState CombState)


    Activates a combined state

The owner of the combined state must be top model in current active window.

Exceptions thrown (but not limited to):

XToolkitNotFound - No such combined states in the specified model.


Manual References:
Solid: Combined States of a Solid, Solid: Combined States of a Solid
Parameters:
CombState
combined state item to be activated
Returns:


CreateCombState

CombStateCreateCombState (String CombStateName, CombStateData CombStateData)


    Create combined state

Exceptions thrown (but not limited to):

XToolkitInvalidType - Invalid references. Possible errors: - The type of one of the references is not valid. - Reference of some type appears twice or more. - Id and type of a reference don't match.


Manual References:
Solid: Combined States of a Solid, Solid: Combined States of a Solid
Parameters:
CombStateName
Name of the new state
CombStateData
combined state dataCombStateData
Returns:
 


DeleteCombState

voidDeleteCombState (CombState CombState)


    Deletes a combined state

Exceptions thrown (but not limited to):

XToolkitNotFound - No such combined states in the specified model.

XToolkitInUse - Can't delete active combined state.


Manual References:
Solid: Combined States of a Solid, Solid: Combined States of a Solid
Parameters:
CombState
Combined state item to be deleted
Returns:


GetAnnotationsOfActiveState

CombStateAnnotationsGetAnnotationsOfActiveState ()


    Gets annotations of active combined state

Exceptions thrown (but not limited to):

XToolkitUnsupported - Not Supported for Creo3 or earlier compatible session handle.Use pfcGetCurrentSessionWithCompatibility(pfcC4Compatible) to get Creo4 or later compatible session handle.


Manual References:
Solid: Combined States of a Solid, Solid: Combined States of a Solid
Returns:
Returns wfcCombStateAnnotations_ptr


GetStyleStateFromName

StyleStateGetStyleStateFromName (String StyleStateName)


    Returns the handle to the specified style state
Manual References:
Solid: Solid Operations, Solid: Solid Operations
Parameters:
StyleStateName
The name of the style state in the solid
Returns:
 


GetStyleStateFromId

StyleStateGetStyleStateFromId (int StyleStateId)


    >Returns the handle to the specified style state
Manual References:
Solid: Solid Operations, Solid: Solid Operations
Parameters:
StyleStateId
The identifier of the style state
Returns:
 


GetActiveStyleState

StyleStateGetActiveStyleState ()


    Returns the current active style state
Manual References:
Solid: Solid Operations, Solid: Solid Operations
Returns:
 


ActivateStyleState

voidActivateStyleState (StyleState WStyleState, boolean RedisplayFlag)


    Activates the style state
Manual References:
Solid: Solid Operations, Solid: Solid Operations
Parameters:
WStyleState
Style state handle
RedisplayFlag
Flag to specify whether or not user needs to redisplay assembly in the window inside this call. If set to true, user is solely responsible for calling Window.Repaint() or something else to refresh assembly view.
Returns:


ListStyleStateItems

StyleStatesListStyleStateItems ()


    Returns list of style state in the solid

Exceptions thrown (but not limited to):

XToolkitNotFound - No Comp Displays were found.


Manual References:
Solid: Solid Operations, Solid: Solid Operations
Returns:
 


ListLayerStates

LayerStatesListLayerStates ()


    Gets Layer state list.

Exceptions thrown (but not limited to):

XToolkitNotFound - No layer states in the model.


Manual References:
ModelItem: Layer State, ModelItem: Layer State
Returns:
 


CreateLayerState

LayerStateCreateLayerState (LayerStateData LayerStateData)


    Create Layer state from references.

Note:wfcLayerItem of type wfcLAYER_LAYER cannot be added to Layer States using CreateLayerState.

Exceptions thrown (but not limited to):

XToolkitInvalidItem - Size of arrays don't match. See description above.

XToolkitInvalidName - Layer state name is invalid. The name may be too long or contains invalid characters.

XToolkitFound - Provided layer state name already exists in the model.


Manual References:
ModelItem: Layer State, ModelItem: Layer State
Parameters:
LayerStateData
 
Returns:
 


GetActiveLayerState

LayerStateGetActiveLayerState ()


    Get active layer state on a model.

Exceptions thrown (but not limited to):

XToolkitNotFound - No active layer state on the model.


Manual References:
ModelItem: Layer State, ModelItem: Layer State
Returns:
 


GetTolerance

doubleGetTolerance (ToleranceType Type, int Decimals)


    Retreives the tolerance value for the specified solid, for the specified number of decimal places.
Manual References:
Dimensions and Parameters: Dimension Tolerances, Dimensions and Parameters: Dimension Tolerances
Parameters:
Type
The tolerance type.
Decimals
The number of decimal places used to identify tolerance.
Returns:
 


SetTolerance

voidSetTolerance (ToleranceType Type, int Decimals, double Tolerance)


    Sets the solid's tolerance, at the specified number of decimal places, to the specified value.
Manual References:
Dimensions and Parameters: Dimension Tolerances, Dimensions and Parameters: Dimension Tolerances
Parameters:
Type
The tolerance type.
Decimals
The number of decimal places used to identify tolerance.
Tolerance
The tolerance, at the specified number of decimal places.
Returns:


LoadToleranceClass

voidLoadToleranceClass (String ToleranceClassName)


    This will load a tolerance class for Hole or Shaft ISO tols.

Exceptions thrown (but not limited to):

XToolkitNotFound - Creo Parametric TOOLKIT could not find the table.


Manual References:
Dimensions and Parameters: Dimension Tolerances, Dimensions and Parameters: Dimension Tolerances
Parameters:
ToleranceClassName
 
Returns:


GetModelClass

ModelClassGetModelClass ()


    Gets the ISO/DIN model class type for a solid model.

Exceptions thrown (but not limited to):

XToolkitBadContext - The solid was not using ISO/DIN tolerance tables.


Manual References:
Dimensions and Parameters: Dimension Tolerances, Dimensions and Parameters: Dimension Tolerances
Returns:
wfcModelClass


SetModelClass

voidSetModelClass (ModelClass ModelClass)


    Sets the ISO/DIN model class type for a solid model.

Exceptions thrown (but not limited to):

XToolkitCantModify - The model was locked.

XToolkitBadContext - The model was not using ISO/DIN tolerance tables.


Manual References:
Dimensions and Parameters: Dimension Tolerances, Dimensions and Parameters: Dimension Tolerances
Parameters:
ModelClass
 
Returns:


CheckFamilyTable

FamilyTableStatusCheckFamilyTable ()


     Determines whether the specified solid has a family table, and if that family table is valid and/or empty.

Exceptions thrown (but not limited to):

XToolkitNotFound - The family table was not found for the specified owner.

XToolkitEmpty - The family table is found and is empty.


Manual References:
Solid: Solid Operations
Returns:
wfcFamilyTableStatus


DisplaySolid

voidDisplaySolid ()


    Displays the specified object.

Exceptions thrown (but not limited to):

XToolkitFound - The model is already in a window (from calling wfcWSession::OpenSource).


Manual References:
Solid: Displaying a Solid
Returns:


GetDefaultTextHeight

doubleGetDefaultTextHeight ()


     Obtains the default text height used for text in annotations and dimensions in the solid model.
Manual References:
Solid: Annotations
Returns:
 


FindShellsAndVoids

ShellDataFindShellsAndVoids ()


     For each shell and void of solid, returns surface-contour pairs which describe them.

When the surface is split into a few pieces (has more than one external contour) these pieces may belong to different shells. Hence, each shell face has to be described by a pair (surface id, ProContour).

Exceptions thrown (but not limited to):

XToolkitNotFound - The solid has no geometry.

XToolkitNotValid - the topology of solid is not valid.


Manual References:
Solid: Solid Operations, Solid: Solid Operations
Returns:
wfcShelllData


ProjectPoint

ProjectionInfoProjectPoint (Point3D Point, double Tolerance)


     finds a surface from the solid within the maximum distance, and returns the UV point of the projection of the point to that surface.

This function supports parts only, not assemblies.

Exceptions thrown (but not limited to):

XToolkitNotExist - The function failed to find a point on a surface within the tolerance.


Manual References:
Geometry Evaluation: Geometry of Points, Geometry Evaluation: Geometry of Points
Parameters:
Point
The point to project.
Tolerance
Maximum allowed distance from the point to the solid.
Returns:
wfcProjectionInfo


GetDisplayOutline

Outline3DGetDisplayOutline (Matrix3D Matrix)


    Computes the display outline of a solid.
Manual References:
Solid: Solid Operations, Solid: Solid Operations, Annotations: Annotation Features and Annotations: Modifying 3D Note Attachments
Parameters:
Matrix
 
Returns:
pfcOutline3D


GetAxis

WAxisGetAxis (int AxisId)


    Initializes the Axis handle
Manual References:
Geometry Evaluation: Evaluation of ModelItems, Geometry Evaluation: Evaluation of ModelItems
Parameters:
AxisId
Axis Id
Returns:
Axis handle


GetCurve

WCurveGetCurve (int CurveId)


    Returns curve handle
Manual References:
Geometry Evaluation: Curve Descriptors
Parameters:
CurveId
Curve Id
Returns:
Curve handle


GetCsys

WCsysGetCsys (int CsysId)


    >Returns Csys handle
Manual References:
Geometry Evaluation: Evaluation of ModelItems, Geometry Evaluation: Evaluation of ModelItems
Parameters:
CsysId
Csys Id
Returns:
Csys handle


GetEdge

WEdgeGetEdge (int EdgeId)


     Returns Edge handle
Parameters:
EdgeId
Edge Id
Returns:
Edge handle


GetPoint

WPointGetPoint (int PointId)


     Returns Point handle
Parameters:
PointId
Point Id
Returns:
Point handle


GetQuilt

WQuiltGetQuilt (int QuiltId)


     Returns Quilt handle
Manual References:
Geometry Evaluation: Geometry of Quilts, Geometry Evaluation: Geometry of Quilts
Parameters:
QuiltId
Quilt Id
Returns:
Quilt handle


CreateZoneSectionFeature

WFeatureCreateZoneSectionFeature (ZoneFeatureReferences RefData, String ZoneName)


     Creates a Zone feature.

Exceptions thrown (but not limited to):

XToolkitFound - Zone with given name already exists.


Manual References:
Features: Feature Information, Features: Feature Information
Parameters:
RefData
References needed to create zone feature
ZoneName
Name of the zone feature
Returns:
A feature object


GetAllAppearancesAndTextures

/*optional*/ ItemAppearanceAndTexturesSeqGetAllAppearancesAndTextures ()


    Gets the appearance properties, texture placement properties and texture properties applied on a model. These may not be the properties that are currently visible on the model because they may be overriden by other higher level color application.

Exceptions thrown (but not limited to):

XToolkitNotFound - Data does not exist.


Returns:
The ItemAppearanceAndTexturesSeq object.


CreateDimension

DimensionCreateDimension (AnnotationPlane AnnotPlane, DimensionAttachments DimAttachs, DimSenses Senses, DimOrientationHint OrientHint, Point3D Location)

LICENSE: 222

     

Exceptions thrown (but not limited to):

XToolkitBadDimAttach - A dimension could not be created with the attachments and sense specified.


Manual References:
Annotations: Annotation Features and Annotations: Accessing Reference and Driven Dimensions
Parameters:
AnnotPlane
 
DimAttachs
 
Senses
 
OrientHint
 
Location
 
Returns:
 


CreateRefDimension

DimensionCreateRefDimension (AnnotationPlane AnnotPlane, DimensionAttachments DimAttachs, DimSenses Senses, DimOrientationHint OrientHint, Point3D Location)

LICENSE: 222

     

Exceptions thrown (but not limited to):

XToolkitBadDimAttach - A dimension could not be created with the attachments and sense specified.


Parameters:
AnnotPlane
 
DimAttachs
 
Senses
 
OrientHint
 
Location
 
Returns:
 


RefreshDetailTree

voidRefreshDetailTree ( /*optional*/ Window SolidWindow)


    Rebuild the tree for the solid in the window.

Exceptions thrown (but not limited to):

XToolkitNoChange - There is no change in the detail tree.


Manual References:
Annotations: Annotation Features and Annotations: Detail Tree
Parameters:
SolidWindow
The window containing the solid. By default, the detail tree in the active window is used.
Returns:


ExpandDetailTree

voidExpandDetailTree ( /*optional*/ Window SolidWindow)


    Expand the tree for the solid in the window.

Exceptions thrown (but not limited to):

XToolkitNoChange - There is no change in the detail tree.


Manual References:
Annotations: Annotation Features and Annotations: Detail Tree, Annotations: Annotation Features and Annotations: Detail Tree
Parameters:
SolidWindow
The window containing the solid. By default, the detail tree in the active window is used.
Returns:


CollapseDetailTree

voidCollapseDetailTree ( /*optional*/ Window SolidWindow)


    Collapse the tree for the solid in the window.

Exceptions thrown (but not limited to):

XToolkitNoChange - There is no change in the detail tree.


Manual References:
Annotations: Annotation Features and Annotations: Detail Tree, Annotations: Annotation Features and Annotations: Detail Tree
Parameters:
SolidWindow
The window containing the solid. By default, the detail tree in the active window is used.
Returns:


CreateFlatToScreenPlane

AnnotationPlaneCreateFlatToScreenPlane (boolean ScreenOrMdlPoint)


     
Manual References:
Annotations: Annotation Features and Annotations: Annotation Orientation, Annotations: Annotation Features and Annotations: Annotation Orientation
Parameters:
ScreenOrMdlPoint
 
Returns:
 


CreateAnnotationPlaneFromView

AnnotationPlaneCreateAnnotationPlaneFromView (String ViewName)


     
Manual References:
Annotations: Annotation Features and Annotations: Annotation Orientation, Annotations: Annotation Features and Annotations: Annotation Orientation
Parameters:
ViewName
 
Returns:
 


CreateFreeNote

DetailNoteItemCreateFreeNote (DetailTextLines TextLines, FreeAttachment Attach)


     

Exceptions thrown (but not limited to):

XToolkitBadContext - The note text cannot be varied.


Manual References:
Annotations: Annotation Features and Annotations: Modifying 3D Note Attachments
Parameters:
TextLines
 
Attach
 
Returns:
 


CreateOnItemNote

DetailNoteItemCreateOnItemNote (DetailTextLines TextLines, AnnotationPlane AnnotPlane, ParametricAttachment Attach)

LICENSE: 222

     

Exceptions thrown (but not limited to):

XToolkitBadContext - The note text cannot be varied.

XToolkitNoLicense - License check failure.


Manual References:
Annotations: Annotation Features and Annotations: Modifying 3D Note Attachments, Annotations: Annotation Features and Annotations: Modifying 3D Note Attachments
Parameters:
TextLines
 
AnnotPlane
 
Attach
 
Returns:
 


CreateLeaderNote

DetailNoteItemCreateLeaderNote (DetailTextLines TextLines, Attachment NoteAttach, DetailLeaderAttachments LeadrAttachs)


     

Exceptions thrown (but not limited to):

XToolkitBadContext - The note text cannot be varied.


Parameters:
TextLines
 
NoteAttach
 
LeadrAttachs
 
Returns:
 


CreateLeaderWithArrowTypeNote

DetailNoteItemCreateLeaderWithArrowTypeNote (DetailTextLines TextLines, Attachment NoteAttach, DetailLeaderAttachments LeadrAttachs, AnnotationPlane AnnotPlane, LeaderArrowTypes Types)

LICENSE: 222

     

Exceptions thrown (but not limited to):

XToolkitBadContext - The note text cannot be varied. OR Invalid leader type for this note attachment.

XToolkitNoLicense - License check failure.


Parameters:
TextLines
 
NoteAttach
 
LeadrAttachs
 
AnnotPlane
 
Types
 
Returns:
 


RetrieveSymbolDefItem

DetailSymbolDefItemRetrieveSymbolDefItem (String FileName, DetailSymbolDefItemSource Source, /*optional*/ String FilePath, /*optional*/ Integer Version, /*optional*/ Boolean UpdateUnconditionally)

LICENSE: 222

    Retrieve a symbol definition.

Exceptions thrown (but not limited to):

XToolkitNotFound - The specified symbol does not exist.

XToolkitFound - The specified symbol exist but was not retrieved.


Manual References:
Annotations: Annotation Features and Annotations: Locating and Collecting 3D Symbols and Symbol Definitions
Parameters:
FileName
The name of the symbol definition file.
Source
The location to search for the symbol definition file.
FilePath
The path to the file with a symbol definition. If not given, then the symbol definition is located in the designated directory.
Version
The version of the symbol definition file. Pass -1 to get the latest version.
UpdateUnconditionally
Update flag. xtrue - Update the existing symbol definition unconditionally. xfalse- Do not load new definition if the same symbol exist in the drawing.
Returns:
Retrieved symbol definition.


CreateAnnotationFeature

AnnotationFeatureCreateAnnotationFeature ( /*optional*/ ComponentPath CompPath, boolean InvokeUI)

LICENSE: 222

    Creates a new annotation feature in the model.

Exceptions thrown (but not limited to):

XToolkitUserAbort - The user cancelled the feature creation (if InvokeUI = true).

XToolkitBadContext - The owner is not the current model (if InvokeUI = true).


Parameters:
CompPath
The component path in case feature is being created in an assembly.
InvokeUI
true to invoke the annotation feature creation User Interface. false to create a feature automatically containing a single general annotation element.
Returns:
 


CreateSymbolDefinition

DetailSymbolDefItemCreateSymbolDefinition (DetailSymbolDefInstructions Instructions)


     
Parameters:
Instructions
 
Returns:
 


CreateSymbolInstance

DetailSymbolInstItemCreateSymbolInstance (DetailSymbolInstInstructions Instructions, AnnotationPlane AnnotPlane)

LICENSE: 222

     
Parameters:
Instructions
 
AnnotPlane
Returns:
 


CreateOrdinateDimension

WDimensionCreateOrdinateDimension (AnnotationType AnnotType, AnnotationElement AnnotationElement, DimensionAttachment DimAttach, DimSenses Senses, DimOrientationHint OrientHint, Point3D Location)

LICENSE: 222

     

Exceptions thrown (but not limited to):

XToolkitBadDimAttach - The dimension cannot be created referencing the given baseline and attachment geometry.


Manual References:
Drawings: Ordinate Dimensions
Parameters:
AnnotType
 
AnnotationElement
 
DimAttach
Senses
 
OrientHint
Location
 
Returns:
 


Tessellate

SurfaceTessellationDataSeqTessellate (double ChordHeight, double AngleControl, boolean IncludeQuilts)


     
Manual References:
Geometry Evaluation: Part and Assembly Tessellation, Geometry Evaluation: Part and Assembly Tessellation
Parameters:
ChordHeight
AngleControl
IncludeQuilts
Returns:


CreateCustomFeature

WFeatureCreateCustomFeature (String CustomFeatXmlFile, String ElemTreeXmlFile, FeatCreateOptions Options, /*optional*/ WRegenInstructions Instrs)


     Create custom feature

This method is reserved for future use.
Parameters:
CustomFeatXmlFile
Xml file path for custom feature
ElemTreeXmlFile
Xml file path for Element tree
Options
Feature creation options
Instrs
Regen instrutions
Returns:
Custom Feature


ActivateAutomaticSimpRep

voidActivateAutomaticSimpRep (SimpRep SimpRep)


    Activate user-defined rep as automatic simplified rep.

Exceptions thrown (but not limited to):

XToolkitNotFound - The specified simplified representation was not found in the model.


Manual References:
Simplified Representations: Simplified Representation Utilities
Parameters:
SimpRep
The user defined simplified representation to activate.
Returns:


ConvertAutomaticSimpRep

voidConvertAutomaticSimpRep (SimpRep SimpRep)


    Convert user-defined rep to new automatic simplified rep preserving excluded/substituted data.

Exceptions thrown (but not limited to):

XToolkitNotFound - The specified simplified representation was not found in the model.


Manual References:
Simplified Representations: Simplified Representation Utilities
Parameters:
SimpRep
The user defined simplified representation to convert.
Returns: