| Library | File | Frames | Expand |
| void | AddBeforeModelRetrieveListener (wfcBeforeModelRetrieveActionListener_ptr listen) | |
| DEPRECATED:
since Creo 4
SUCCESSOR(S): pfcActionSource::AddActionListener Adds an action listener to notify you of activating file open dialog using File -> Open. This listener can pass instructions for retrieving model to Creo Parametric. |
||
| void | AddBrowserMessageListener (xrstring key, wfcBrowserMessageListener_ptr Listener) | |
| Add listener callback for browser events. | ||
| void | AddCollectionToSelectionBuffer (wfcCollection_ptr Coll) | |
| Adds collection to selection buffer | ||
| void | AddModelRetrievePreListener (wfcBeforeModelRetrieveListener_ptr listen) | |
| DEPRECATED:
since Creo 4
SUCCESSOR(S): pfcActionSource::AddActionListener Adds an action listener to notify you of activating file open dialog using File -> Open. |
||
| void | AddModelSavePreAllListener (wfcBeforeModelSaveAllListener_ptr listen) | |
| DEPRECATED:
since Creo 4
SUCCESSOR(S): pfcActionSource::AddActionListener |
||
| void | AddNavigatorPaneLayout (xrstring PaneName, xrstring ResFileName, optional xrstring IconFileName) | |
| Add new pane tab with specified name on the Navigator pane. | ||
| void | AutoPropagate () | |
| LICENSE: 222 Automatically propagates annotation elements within the current model to the currently selected feature based on the standard Creo Parametric algorithm. |
||
| wfcWWindow_ptr | CreateAccessorywindowWithTree (xrstring ObjectName, wfcMdlfileType ObjectType, optional xbool EnableTree) | |
| Retrieves a window and attaches the object to it. | ||
| wfcWWindow_ptr | CreateBarewindow (xrstring ObjectName, wfcMdlfileType ObjectType) | |
| Retrieves a window and attaches the object to it. | ||
| wfcElementTree_ptr | CreateElementTree (wfcElements_ptr Elems) | |
| Creates an element tree from the elements and returns a handle to wfcElementTree | ||
| wfcElementTree_ptr | CreateElementTreeFromXML (xrstring Filename) | |
| Creates an element tree from xml file provided. | ||
| wfcExternalObjectClass_ptr | CreateExternalClass (xrstring Name, xint Type) | |
| Registers a new external object class. | ||
| wfcSection_ptr | CreateSection2D () | |
| Allocates a two-dimensional section. | ||
| void | CreateSnapshot (xrstring Name) | |
| Creates a top assembly level snapshot from the current position on screen. Constraints will be copied from the active snapshot. The newly created snapshot will become the active one. | ||
| void | DeleteBrowserMessageListener (xrstring key) | |
| void | DeleteSnapshot (xrstring Name, optional pfcComponentPath_ptr Path) | |
| Deletes snapshot. | ||
| void | DisplayInformationWindow (xrstring FilePath, optional xreal XOffset, optional xreal YOffset, optional xint Rows, optional xint Columns) | |
| Creates a window and shows the text of the file specified by FilePath. | ||
| void | ExecuteMacro () | |
| optional wfcSection_ptr | GetActiveSection () | |
| Returns a copy of the current active sketcher section. | ||
| xstring | GetApplicationPath () | |
| xstring | GetApplicationTextPath () | |
| wfcCreoType | GetCreoType () | |
| Returns the type of Creo which runs this application. | ||
| wfcIntfDataSourceType | GetDataSourceType (pfcIntfType IntfType) | |
| Provide the wfcIntfDataSourceType for given pfcIntfType. | ||
| xreal | GetDefaultTolerance (wfcToleranceType Type, xint Decimals) | |
| Retrieves the current Creo Parametric default tolerance value for the specified number of decimal places. | ||
| xstring | GetDisplayDateCode () | |
| Returns the Creo session's customer visible datecode. | ||
| optional wfcElementWstringOption_ptr | GetElemWstrOption () | |
| void | SetElemWstrOption (optional wfcElementWstringOption_ptr value) | |
| Options used to retrieve string values of elements | ||
| xstring | GetGTolSymbolString (wfcGTolSymbol Symbol, wfcSymbolFont Font) | |
| Get value string of gtol | ||
| wfcImportfeatRedefSourceType | GetImportFeatRedefSourceType (wfcImportFeatRedefOperationType Type) | |
| Provides the wfcFeature::ImportfeatRedefSourceType used to redefine an import feature. | ||
| xbool | GetIncompleteSurfaceTessellationAllowed () | |
| wfcSnapshotTransformations_ptr | GetKinSnapshotTransformations (xrstring Name, optional pfcComponentPath_ptr Path) | |
| This method brings transformation paths and transformation matrices for all components in the snapshot versus top level assembly. | ||
| optional xstring | GetKnownDirectory (wfcKnownDirectoryType dir_type) | |
| wfcLineStyleData_ptr | GetLineStyleData (pfcStdLineStyle LineStyle) | |
| Provides a description of the specified line style. | ||
| wfcMdlfileDescriptor_ptr | GetMdlfileDescriptor (pfcModelDescriptor_ptr ModelDescr) | |
| pfcModel_ptr | GetModelFromMdlfileDescriptor (wfcMdlfileDescriptor_ptr MdlfileDescr) | |
| Returns the model based on the model descriptor input. | ||
| xstring | GetNavigatorPaneComponent (xrstring PaneName, xrstring ComponentLocalName) | |
| Get the changed name of a component in the pane. | ||
| xstring | GetNavigatorPaneDevice (pfcWindow_ptr WindowObject) | |
| Get the name of the navigator pane device specific to window object. | ||
| xstring | GetNavigatorPaneLayoutComponent (xrstring PaneName) | |
| Get the changed name of the top layout in navigator pane. | ||
| xint | GetReleaseNumericVersion () | |
| Returns the integer major version number of the Creo executable that the application is connected to. | ||
| xstring | GetResourcePath () | |
| Provides the resource path of an application. | ||
| pfcSolid_ptr | GetSolid (xrstring Name, pfcModelType Type) | |
| Initializes the ProSolid handle. | ||
| optional xstring | GetTextureFilePath (xrstring TextureFileName, xbool CreateTempFile) | |
| Looks up the full path to the texture, decal, or bump map file indicated. | ||
| wfcUDFVariableParameters_ptr | GetUDFDataDefaultVariableParameters (xrstring Name, optional xrstring Instance) | |
| pfcModel_ptr | ImportAsModel (xrstring FileToImport, pfcNewModelImportType NewModelType, pfcModelType Type, xrstring NewModelName, wfcImportRepType ModelRepType, optional xrstring profile, optional pfcLayerImportFilter_ptr Filter) | |
| Creates a new imported model in the solid. | ||
| xbool | IsOptionOrdered (xrstring OptionName) | |
| Determines whether the specified option is available. | ||
| xbool | IsTextureFileEmbedded (xrstring TextureFileName) | |
| Checks if the texture file was embedded. | ||
| pfcModel_ptr | LoadModelRepresentation (xrstring AssemblyFileName, pfcModelType Type, optional xrstring SimpRepName, optional pfcSimpRepInstructions_ptr Instructions) | |
| Retrieves the specified simplified representation. | ||
| void | MoveKinDrag (pfcSelection_ptr DragPoint, pfcPoint2Ds_ptr Moves) | |
| This method bring to drag this selected object. Displays a hook point around the point. Performs a drag according to the environment set in wfcWSession::SetKinDragEnvironment(wfcKinDragType, optional xrstring, optional pfcComponentPath_ptr, optional pfcSelection_ptr) For dragging use constraints from current snapshot, if it set. After end of the movement the hook point is removed. | ||
| void | MoveKinDragForModel (pfcSelection_ptr DragPoint, pfcPoint3Ds_ptr Moves, optional pfcMatrix3D_ptr Matrix) | |
| This function brings to drag this selected object. Performs a drag according to the environment set in wfcWSession::SetKinDragEnvironment(wfcKinDragType, optional xrstring, optional pfcComponentPath_ptr, optional pfcSelection_ptr) For dragging use constraints from the current snapshot, if it is set. | ||
| pfcDrawing_ptr | OpenDrawingAsReadOnly (xrstring Path) | |
| pfcWindow_ptr | OpenSource (wfcMdlfileDescriptor_ptr MdlfileDesc) | |
| Retrieves the specified model and displays it in a window. | ||
| wfcParsedFileNameData_ptr | ParseFileName (xrstring FileName) | |
| Parses the specified file name into its components. | ||
| void | RegisterExternalSelectionHighlight (wfcExternalSelectionHighlight_ptr RegistrationMethods) | |
| Registers external application highlighting callbacks in order to let application media (like a tree) react on selections made while calling or while in pfcBaseSession::Select(pfcSelectionOptions_ptr, optional pfcSelections_ptr) | ||
| void | ReleaseExternalSelectionHighlight (wfcExternalSelectionHighlight_ptr RegistrationMethods) | |
| Releases the client interface used for external selection. | ||
| wfcStatus | ReleaseVisitor (wfcVisitingClient_ptr visitingClient) | |
| pfcAssembly_ptr | RetrieveAssemblySimpRep (xrstring AssemName, wfcMdlfileType FileType, optional pfcSimpRepInstructions_ptr Instructions) | |
| Retrieves the specified simplified representation. Takes the origin file type into account. | ||
| pfcAssembly_ptr | RetrieveAutomaticSimpRep (xrstring AssemName, wfcMdlfileType FileType, xrstring UDSrepName) | |
| Retrieve user defined simplified representation as automatic rep. | ||
| pfcAssembly_ptr | RetrieveDefaultEnvelopeSimprep (xrstring AssemName) | |
| Retrieves the Default Envelope simplified representation of an assembly | ||
| pfcAssembly_ptr | RetrieveLightweightGraphicsSimpRep (xrstring AssemName) | |
| Retrieves the light-weight graphics simplified representation of an assembly. | ||
| pfcModel_ptr | RetrieveModelByFiletype (wfcMdlfileDescriptor_ptr MdlfileDescr, pfcRetrieveModelOptions_ptr Opts) | |
| Retrieves the specified model into the Creo Parametric session from standard directory. | ||
| pfcSolid_ptr | RetrieveSimpRep (xrstring ModelName, wfcMdlfileType FileType, pfcSimpRepType SimpRepType, optional xrstring ReprName) | |
| Retrieves the specified simplified representation Takes the origin file type into account. | ||
| void | RunAsCreoType (wfcCreoType type) | |
| Sets the type of Creo. | ||
| void | SetIncompleteSurfaceTessellationAllowed (xbool IsAllowed) | |
| void | SetKinDragEnvironment (wfcKinDragType Type, optional xrstring Name, optional pfcComponentPath_ptr Path, optional pfcSelection_ptr Reference) | |
| This method setups the environment for subsequenmt dragging and reconnect operations. Environment can be set / reset several times after wfcWSession::StartKinDrag() is called. | ||
| void | StartKinDrag () | |
| This method starts a drag session it should be called before any other Kinematic drag or Snapshot function is called. All subsequent methods will work with the Snapshots of the window assembly. All component path should start from this assembly. All transforms belong to this assembly. The method can be called for design assemblies in Standard Assembly and Mechanism modes. It cannot be used if assembly is exploded, if sketcher is active, when component placement is active or when drag dialog is on screen. | ||
| void | StopKinDrag () | |
| This method will stop drag session. Method pfcWindow::Refresh() should be performed to see the change of the graphic window scale according to updated outline. | ||
| xbool | UIEditFile (xrstring FileName) | |
| Opens an edit window for the specified file using the default text editor. | ||
| xstring | UIOpenFileType (wfcFiletypeOpenOptions_ptr Options) | |
| Prompts the standard file open browser interface of Creo Parametric. | ||
| xstring | UISaveFileType (wfcFiletypeSaveOptions_ptr Options) | |
| Prompts the standard file save browser interface of Creo Parametric. | ||
| void | UpdateSnapshot (xrstring Name) | |
| Update snapshot. | ||
| wfcCreoType | GetCreoType | () |
|
Returns the type of Creo which runs this application. This method allows the developer to write an application which can be used with different types of Creo (Parametric, Direct etc.) - for instance, avoid calling methods allowed for Creo Parametric in case if the application is run with Creo Direct.
|
| void | RunAsCreoType | (wfcCreoType type) |
|
Sets the type of Creo. This method allows to emulate other Creo types while running the application with Creo Parametric - for instance to check that used methods are enabled for a specific Creo type. It must be used only during the development cycle and removed in the final version of the application. If used with Creo applications other than Creo Parametric, this method will throw an exception. Exceptions thrown (but not limited to): pfcXMethodForbidden - Type is other than <reference 4 to unknown entity wfcCreoType::wfcCREO_PARAMETRIC> .
|
| xstring | GetGTolSymbolString | (wfcGTolSymbol Symbol, wfcSymbolFont Font) |
|
Get value string of gtol
|
| wfcElementTree_ptr | CreateElementTreeFromXML | (xrstring Filename) |
|
Creates an element tree from xml file provided. Reads in the xml file and converts into an element tree Exceptions thrown (but not limited to): pfcXToolkitOutOfMemory - XML Parser failed to initialize pfcXToolkitCantAccess - XML Parser failed during parsing pfcXToolkitCantOpen - XML Parser failed opening DOM Tree pfcXToolkitNotValid - XML Parser failed due to other errors pfcXToolkitAmbiguous - Error occurred during creation of output transcoder pfcXToolkitBadContext - Function failed to create the element tree due to an error in the ProElemId, ProType, or Enum Value in the XML file The function populates the ProArray p_errors to hold the errors ( refer to fields:
|
| wfcElementTree_ptr | CreateElementTree | (wfcElements_ptr Elems) |
|
Creates an element tree from the elements and returns a handle to wfcElementTree
|
| optional wfcElementWstringOption_ptr | GetElemWstrOption | () |
| void | SetElemWstrOption | (optional wfcElementWstringOption_ptr value) |
|
Options used to retrieve string values of elements These options will be considered on call to method wfcElement::GetValueAsString(optional xrstring)
|
| pfcModel_ptr | ImportAsModel | (xrstring FileToImport, pfcNewModelImportType NewModelType, pfcModelType Type, xrstring NewModelName, wfcImportRepType ModelRepType, optional xrstring profile, optional pfcLayerImportFilter_ptr Filter) |
|
Creates a new imported model in the solid. Exceptions thrown (but not limited to): pfcXToolkitCantOpen - import_file can't be opened. pfcXToolkitUnsupported - Creo Parametric does not support import of the indicated file. pfcXToolkitNotExist - No profile found. pfcXToolkitInvalidFile - profile is not readable. pfcXToolkitInvalidType - This combination of arguments is invalid. pfcXToolkitLineTooLong - Name length of new model is more than 31 chars.
|
| optional wfcSection_ptr | GetActiveSection | () |
|
Returns a copy of the current active sketcher section. If Intent Manager mode is supposed to be used for this section,the call wfcSection::SetIntentManagerMode(xbool) to true must follow this method You must be in active sketcher mode to get section. Exceptions thrown (but not limited to): pfcXToolkitBadContext - Section not in sketcher mode.
|
| wfcSection_ptr | CreateSection2D | () |
|
Allocates a two-dimensional section. Exceptions thrown (but not limited to): pfcXToolkitOutOfMemory - There was a memory error.
|
| xstring | GetDisplayDateCode | () |
|
Returns the Creo session's customer visible datecode. The datecode is returned in the same format as shown in Creo Parametric Help information. Note for the users of C++ Object Toolkit: If it is necessary to show an identifier for the Creo version to the user from an application, this value should be used, rather than the value passed in to the application's user_initialize().
|
| xint | GetReleaseNumericVersion | () |
|
Returns the integer major version number of the Creo executable that the application is connected to. The returned value is an absolute number counting from the first shipment of PTC's MCAD software; for Creo Parametric 2.0 it is 31.
|
| void | AddCollectionToSelectionBuffer | (wfcCollection_ptr Coll) |
|
Adds collection to selection buffer
|
| void | RegisterExternalSelectionHighlight | (wfcExternalSelectionHighlight_ptr RegistrationMethods) |
|
Registers external application highlighting callbacks in order to let application media (like a tree) react on selections made while calling or while in pfcBaseSession::Select(pfcSelectionOptions_ptr, optional pfcSelections_ptr) The client instance, passed is an input to the method, should be released after the application is done with using it.
|
| void | ReleaseExternalSelectionHighlight | (wfcExternalSelectionHighlight_ptr RegistrationMethods) |
|
Releases the client interface used for external selection.
|
| pfcAssembly_ptr | RetrieveLightweightGraphicsSimpRep | (xrstring AssemName) |
|
Retrieves the light-weight graphics simplified representation of an assembly. This method is a shortcut for wfcWSession::RetrieveSimpRep(xrstring, wfcMdlfileType, pfcSimpRepType, optional xrstring) Exceptions thrown (but not limited to): pfcXToolkitNoPermission - The function does not have permission to operate on this assembly.
|
| pfcAssembly_ptr | RetrieveDefaultEnvelopeSimprep | (xrstring AssemName) |
|
Retrieves the Default Envelope simplified representation of an assembly This method is a shortcut for wfcWSession::RetrieveSimpRep(xrstring, wfcMdlfileType, pfcSimpRepType, optional xrstring) Operates on assemblies only, not parts Exceptions thrown (but not limited to): pfcXToolkitNoPermission - The function does not have permission to operate on this assembly.
|
| pfcAssembly_ptr | RetrieveAssemblySimpRep | (xrstring AssemName, wfcMdlfileType FileType, optional pfcSimpRepInstructions_ptr Instructions) |
|
Retrieves the specified simplified representation. Takes the origin file type into account. This method supports Multi-CAD models. Exceptions thrown (but not limited to): pfcXToolkitNoPermission - The function does not have permission to operate on this assembly. pfcXToolkitNotFound - The function did not find the simplified representation in the solid.
|
| pfcSolid_ptr | RetrieveSimpRep | (xrstring ModelName, wfcMdlfileType FileType, pfcSimpRepType SimpRepType, optional xrstring ReprName) |
|
Retrieves the specified simplified representation Takes the origin file type into account. This method supports Multi-CAD models. If errors occur in regeneration, the model will include suppressed features. Use pfcSolid::HasRetrievalErrors() to identify the errors. Exceptions thrown (but not limited to): pfcXToolkitNoPermission - The function does not have permission to operate on this model.
|
| xreal | GetDefaultTolerance | (wfcToleranceType Type, xint Decimals) |
|
Retrieves the current Creo Parametric default tolerance value for the specified number of decimal places.
|
| pfcModel_ptr | LoadModelRepresentation | (xrstring AssemblyFileName, pfcModelType Type, optional xrstring SimpRepName, optional pfcSimpRepInstructions_ptr Instructions) |
|
Retrieves the specified simplified representation. Exceptions thrown (but not limited to): pfcXToolkitNotFound - The file was not found. pfcXToolkitCantOpen - The file exists but is not readable. pfcXToolkitEmpty - The specified representation was not stored in the file (for non user-defined representations). pfcXToolkitInvalidFile - The model is not a Creo Parametric model. pfcXToolkitLineTooLong - The model name is too long. pfcXToolkitInvalidName - The specified user defined representation was not found (in which case it may be created on the fly following instructions in p_simp_rep_data - check p_result for being not NULL) pfcXToolkitNoPermission - The function does not have permission to operate on this model.
|
| pfcSolid_ptr | GetSolid | (xrstring Name, pfcModelType Type) |
|
Initializes the ProSolid handle.
|
| wfcImportfeatRedefSourceType | GetImportFeatRedefSourceType | (wfcImportFeatRedefOperationType Type) |
|
Provides the wfcFeature::ImportfeatRedefSourceType used to redefine an import feature.
|
| wfcLineStyleData_ptr | GetLineStyleData | (pfcStdLineStyle LineStyle) |
|
Provides a description of the specified line style. Exceptions thrown (but not limited to): pfcXToolkitInvalidPtr - The style_info == NULL.
|
| wfcIntfDataSourceType | GetDataSourceType | (pfcIntfType IntfType) |
|
Provide the wfcIntfDataSourceType for given pfcIntfType.
|
| wfcWWindow_ptr | CreateAccessorywindowWithTree | (xrstring ObjectName, wfcMdlfileType ObjectType, optional xbool EnableTree) |
|
Retrieves a window and attaches the object to it. If the window is already open with the object attached, the function returns the window.If there is an empty window up, the function attaches the object to it.Otherwise, the function creates a new window and attaches the object to it. The window created is smaller than the one created by pfcBaseSession::CreateModelWindow(pfcModel_ptr) This window doesn't have the toolbar. It doesn't allow any options and has restricted options under Windows menu. Exceptions thrown (but not limited to): pfcXToolkitInvalidType - You specified an invalid object type. pfcXToolkitNotFound - The application is trying to open an embedded model (that is, a model representing a single body of a multi-body foreign object) in a separate window. This operation is not supported.
|
| wfcWWindow_ptr | CreateBarewindow | (xrstring ObjectName, wfcMdlfileType ObjectType) |
|
Retrieves a window and attaches the object to it. If the window is already open with the object attached, the function returns the window. If there is an empty window up, the function attaches the object to it. Otherwise, the function creates a new window and attaches the object to it. The window created doesn't have any toolbars or menus. It can be minimized or closed and it has all the regular mouse-driven view capabilites like zoom, rotation and panning. Exceptions thrown (but not limited to): pfcXToolkitInvalidType - You specified an invalid object type. pfcXToolkitNotFound - The application is trying to open an embedded model (that is, a model representing a single body of a multi-body foreign object) in a separate window. This operation is not supported.
|
| xbool | IsTextureFileEmbedded | (xrstring TextureFileName) |
|
Checks if the texture file was embedded. Exceptions thrown (but not limited to): pfcXToolkitNotFound - The texture file could not be found on disk or in memory. pfcXToolkitCantWrite - The temporary texture file could not be written.
|
| optional xstring | GetTextureFilePath | (xrstring TextureFileName, xbool CreateTempFile) |
|
Looks up the full path to the texture, decal, or bump map file indicated. If the texture is embedded inside a Creo Parametric model, instead of being loaded from the texture path, this function will write a temporary copy of the file if CreateTempFile is set to Exceptions thrown (but not limited to): pfcXToolkitNotFound - The texture file could not be found on disk or in memory. pfcXToolkitCantWrite - The temporary texture file could not be written.
|
| void | DisplayInformationWindow | (xrstring FilePath, optional xreal XOffset, optional xreal YOffset, optional xint Rows, optional xint Columns) |
|
Creates a window and shows the text of the file specified by FilePath.
|
| pfcDrawing_ptr | OpenDrawingAsReadOnly | (xrstring Path) |
|
| xbool | UIEditFile | (xrstring FileName) |
|
Opens an edit window for the specified file using the default text editor. Exceptions thrown (but not limited to): pfcXToolkitNoChange - The user quit from the editor.
|
| wfcParsedFileNameData_ptr | ParseFileName | (xrstring FileName) |
|
Parses the specified file name into its components.
|
| xstring | UIOpenFileType | (wfcFiletypeOpenOptions_ptr Options) |
|
Prompts the standard file open browser interface of Creo Parametric. Exceptions thrown (but not limited to): pfcXToolkitUserAbort - The user aborted from the user interface.
|
| xstring | UISaveFileType | (wfcFiletypeSaveOptions_ptr Options) |
|
Prompts the standard file save browser interface of Creo Parametric. For Multi-CAD objects, this method does not support local disk saving location in a Windchill connected session. Exceptions thrown (but not limited to): pfcXToolkitUserAbort - The user aborted from the user interface.
|
| xbool | IsOptionOrdered | (xrstring OptionName) |
|
Determines whether the specified option is available. Exceptions thrown (but not limited to): pfcXToolkitNotFound - The specified option was not found.
|
| xstring | GetResourcePath | () |
|
Provides the resource path of an application. This function can be used only to obtain the resource path. The path and its contents must not be altered in any way; an attempt to do so will make the application behavior unpredictable.
|
| wfcMdlfileDescriptor_ptr | GetMdlfileDescriptor | (pfcModelDescriptor_ptr ModelDescr) |
|
| pfcWindow_ptr | OpenSource | (wfcMdlfileDescriptor_ptr MdlfileDesc) |
|
Retrieves the specified model and displays it in a window. This method opens the file and displays it in a new window. It accepts filetypes supported by Multi-CAD approach. Exceptions thrown (but not limited to): pfcXToolkitNotFound - This means either:
pfcXToolkitNoPermission - The function does not have permission to operate on this model. pfcXToolkitBadContext - The Multi-CAD model is not being retrieved from an active Windchill server. pfcXToolkitInvalidType - You specified an invalid object type. pfcXToolkitDeadLock - The Creo Parametric user interface is not prepared to handle this request (because it is blocked by another process such as an OLE container activation).
|
| pfcModel_ptr | RetrieveModelByFiletype | (wfcMdlfileDescriptor_ptr MdlfileDescr, pfcRetrieveModelOptions_ptr Opts) |
|
Retrieves the specified model into the Creo Parametric session from standard directory. The method does not create a window for the model or display it anywhere. The model can be retrieved only from standard directory. Path argument in model descriptor is ignored by this api. It accepts filetypes supported by Multi-CAD approach. Exceptions thrown (but not limited to): pfcXToolkitNotFound - The model was not found in the current directory. pfcXToolkitNoPermission - The function does not have permission to operate on this model. pfcXToolkitBadContext - The Multi-CAD model is not being retrieved from an active Windchill server.
|
| wfcExternalObjectClass_ptr | CreateExternalClass | (xrstring Name, xint Type) |
|
Registers a new external object class. Exceptions thrown (but not limited to): pfcXToolkitFound - The external object class already exists.
|
| void | AddNavigatorPaneLayout | (xrstring PaneName, xrstring ResFileName, optional xrstring IconFileName) |
|
Add new pane tab with specified name on the Navigator pane.
|
| xstring | GetNavigatorPaneDevice | (pfcWindow_ptr WindowObject) |
|
Get the name of the navigator pane device specific to window object.
|
| xstring | GetNavigatorPaneComponent | (xrstring PaneName, xrstring ComponentLocalName) |
|
Get the changed name of a component in the pane. Exceptions thrown (but not limited to): pfcXToolkitMsgTooLong - Pane name is too long.
|
| xstring | GetNavigatorPaneLayoutComponent | (xrstring PaneName) |
|
Get the changed name of the top layout in navigator pane. Exceptions thrown (but not limited to): pfcXToolkitMsgTooLong - Pane name is too long.
|
| pfcModel_ptr | GetModelFromMdlfileDescriptor | (wfcMdlfileDescriptor_ptr MdlfileDescr) |
|
Returns the model based on the model descriptor input. Exceptions thrown (but not limited to): pfcXToolkitNotFound - Unable to find the required model.
|
| void | AddModelRetrievePreListener | (wfcBeforeModelRetrieveListener_ptr listen) |
| DEPRECATED:
since Creo 4
SUCCESSOR(S): pfcActionSource::AddActionListener Adds an action listener to notify you of activating file open dialog using File -> Open. Warning: This notification blocks Creo Parametric or Direct's standard file open dialog. It is developer's responsibility to substitute it with his own dialog through this function.
|
| void | AddBeforeModelRetrieveListener | (wfcBeforeModelRetrieveActionListener_ptr listen) |
| DEPRECATED:
since Creo 4
SUCCESSOR(S): pfcActionSource::AddActionListener Adds an action listener to notify you of activating file open dialog using File -> Open. This listener can pass instructions for retrieving model to Creo Parametric. Warning: This notification blocks Creo Parametric or Direct's standard file open dialog. It is developer's responsibility to substitute it with his own dialog through this function.
|
| void | AddModelSavePreAllListener | (wfcBeforeModelSaveAllListener_ptr listen) |
| DEPRECATED:
since Creo 4
SUCCESSOR(S): pfcActionSource::AddActionListener
|
| wfcUDFVariableParameters_ptr | GetUDFDataDefaultVariableParameters | (xrstring Name, optional xrstring Instance) |
|
Exceptions thrown (but not limited to): pfcXToolkitNotValid - If the variant item type is not parameter or annotation. pfcXToolkitNoLicense - No license is available for this function. pfcXToolkitBadContext - Cannot access the UDF data because the name and path have not been set. pfcXToolkitCantOpen - Cannot access the UDF .gph file at the path specified. pfcXToolkitNotFound - This UDF does not have any variable items.
|
| wfcStatus | ReleaseVisitor | (wfcVisitingClient_ptr visitingClient) |
|
| void | AutoPropagate | () |
| LICENSE: 222
Automatically propagates annotation elements within the current model to the currently selected feature based on the standard Creo Parametric algorithm. The behavior is based on the current contents of the selection buffer. Exceptions thrown (but not limited to): pfcXToolkitBadContext - The current selections do not allow propagation of annotation elements. pfcXToolkitNoLicense - No license is available for this function.
|
| xstring | GetApplicationPath | () |
|
| xstring | GetApplicationTextPath | () |
|
| void | ExecuteMacro | () |
|
| optional xstring | GetKnownDirectory | (wfcKnownDirectoryType dir_type) |
|
| void | AddBrowserMessageListener | (xrstring key, wfcBrowserMessageListener_ptr Listener) |
|
Add listener callback for browser events.
|
| void | DeleteBrowserMessageListener | (xrstring key) |
|
| xbool | GetIncompleteSurfaceTessellationAllowed | () |
|
| void | SetIncompleteSurfaceTessellationAllowed | (xbool IsAllowed) |
|
| pfcAssembly_ptr | RetrieveAutomaticSimpRep | (xrstring AssemName, wfcMdlfileType FileType, xrstring UDSrepName) |
|
Retrieve user defined simplified representation as automatic rep. Exceptions thrown (but not limited to): pfcXToolkitNoPermission - The function does not have permission to operate on this assembly. pfcXToolkitNotFound - The function did not find the simplified representation in the solid.
|
| void | StartKinDrag | () |
|
This method starts a drag session it should be called before any other Kinematic drag or Snapshot function is called. All subsequent methods will work with the Snapshots of the window assembly. All component path should start from this assembly. All transforms belong to this assembly. The method can be called for design assemblies in Standard Assembly and Mechanism modes. It cannot be used if assembly is exploded, if sketcher is active, when component placement is active or when drag dialog is on screen.
|
| void | StopKinDrag | () |
|
This method will stop drag session. Method pfcWindow::Refresh() should be performed to see the change of the graphic window scale according to updated outline.
|
| void | MoveKinDrag | (pfcSelection_ptr DragPoint, pfcPoint2Ds_ptr Moves) |
|
This method bring to drag this selected object. Displays a hook point around the point. Performs a drag according to the environment set in wfcWSession::SetKinDragEnvironment(wfcKinDragType, optional xrstring, optional pfcComponentPath_ptr, optional pfcSelection_ptr) For dragging use constraints from current snapshot, if it set. After end of the movement the hook point is removed.
|
| wfcSnapshotTransformations_ptr | GetKinSnapshotTransformations | (xrstring Name, optional pfcComponentPath_ptr Path) |
|
This method brings transformation paths and transformation matrices for all components in the snapshot versus top level assembly.
|
| void | SetKinDragEnvironment | (wfcKinDragType Type, optional xrstring Name, optional pfcComponentPath_ptr Path, optional pfcSelection_ptr Reference) |
|
This method setups the environment for subsequenmt dragging and reconnect operations. Environment can be set / reset several times after wfcWSession::StartKinDrag() is called.
|
| void | CreateSnapshot | (xrstring Name) |
|
Creates a top assembly level snapshot from the current position on screen. Constraints will be copied from the active snapshot. The newly created snapshot will become the active one.
|
| void | DeleteSnapshot | (xrstring Name, optional pfcComponentPath_ptr Path) |
|
Deletes snapshot.
|
| void | UpdateSnapshot | (xrstring Name) |
|
Update snapshot.
|
| void | MoveKinDragForModel | (pfcSelection_ptr DragPoint, pfcPoint3Ds_ptr Moves, optional pfcMatrix3D_ptr Matrix) |
|
This function brings to drag this selected object. Performs a drag according to the environment set in wfcWSession::SetKinDragEnvironment(wfcKinDragType, optional xrstring, optional pfcComponentPath_ptr, optional pfcSelection_ptr) For dragging use constraints from the current snapshot, if it is set.
|