Interface UDFCustomCreateInstructions
package com.ptc.pfc.pfcUDFCreate;
public interface UDFCustomCreateInstructions
extends com.ptc.pfc.pfcUDFGroup.UDFGroupCreateInstructions
Description
Contains all options required to place a UDF programmatically. Users can enter attribute data programmatically, or wait for Creo Parametric to interactively prompt for the missing data.
Direct Known Subclasses:
User Guide References:
Creating a Custom UDF:UDFCustomCreateInstructions, Setting the Family Table Instance Name:UDFCustomCreateInstructions, Setting Dependency Type:UDFCustomCreateInstructions, Setting Scale and Scale Type:UDFCustomCreateInstructions, Setting the Appearance of the Non UDF Dimensions:UDFCustomCreateInstructions, Setting the Variable Dimensions and Parameters:UDFCustomCreateInstructions, Setting the User Defined References:UDFCustomCreateInstructions, Setting the Assembly Intersections:UDFCustomCreateInstructions, External Symbol: Parameters:UDFCustomCreateInstructions, External Symbol: Dimensions:UDFCustomCreateInstructions, Setting Orientations:UDFCustomCreateInstructions, Setting Quadrants:UDFCustomCreateInstructions, Setting the External References:UDFCustomCreateInstructions
Methods Inherited from Interface com.ptc.pfc.pfcUDFGroup.UDFGroupCreateInstructions :
GetName, SetName, GetShowUDFEditMenu, SetShowUDFEditMenu, GetShowModifyNCSeqMenu, SetShowModifyNCSeqMenu, GetUseExistingTools, SetUseExistingTools, GetTurnOffUDFRedefineMenu, SetTurnOffUDFRedefineMenu, GetTurnOffFixModelUI, SetTurnOffFixModelUI
Method Summary
/*cipOptional*/ ComponentPath | |
Get method for attribute "AssemblyReference" This property specifies the path to the placement model from the top-level assembly used by reference selections, if the placement model is not the top level assembly. This is necessary whenever external references are used for placement, or whenever the reference selections are made from a context outside of the placement model. | |
/*cipOptional*/ UDFDependencyType | |
Get method for attribute "DependencyType" The dependency of the UDF. The choices correspond to the choices available when you create the UDF interactively. | |
/*cipOptional*/ UDFDimensionDisplayType | |
Get method for attribute "DimDisplayType" These values correspond to the options in Creo Parametric for determining the appearance in the model of UDF dimensions and pattern parameters that were not variable in the UDF, and therefore cannot be modified in the model. | |
/*cipOptional*/ UDFExternalReferences | |
Get method for attribute "ExtReferences" This property is deprecated. To specify the path to the placement model from the top-level assembly used by reference selections use the AssemblyReference property. | |
/*cipOptional*/ String | |
Get method for attribute "InstanceName" If the UDF contains a family table, this field can be used to select which instance in that table is to be selected. If the UDF contains no family table, or if the generic instance is to be selected, the string should be empty. | |
/*cipOptional*/ UDFAssemblyIntersections | |
Get method for attribute "Intersections" An array of intersections of the UDF and parts within the assembly. | |
/*cipOptional*/ UDFOrientations | |
Get method for attribute "Orientations" An array of orientations that provide the answers to Creo Parametric prompts that use a flip arrow. The order of orientations should correspond to the order in which Creo Parametric prompts for them when the UDF is created interactively. If you do not provide an orientation that Creo Parametric needs, it uses the default value ``no flip.'' | |
/*cipOptional*/ Point3Ds | GetQuadrants () |
Get method for attribute "Quadrants" An array of points, which provide the X, Y, and Z coordinates that correspond to the picks answering the Creo Parametric prompts for the feature positions. The order of quadrants should correspond to the order in which Creo Parametric prompts for them when the UDF is created interactively. | |
/*cipOptional*/ UDFReferences | |
Get method for attribute "References" An array of element references. | |
/*cipOptional*/ Double | GetScale () |
Get method for attribute "Scale" If the value of the ScaleType field is UDFSCALE_CUSTOM, this field is the user-defined scale factor. Otherwise, this field is ignored. | |
/*cipOptional*/ UDFScaleType | GetScaleType () |
Get method for attribute "ScaleType" Specifies what should happen if the UDF used different length units than the model to which it is being applied. | |
/*cipOptional*/ UDFVariantValues | |
Get method for attribute "VariantValues" An array of variable dimensions and pattern parameters | |
void | |
Set method for attribute "AssemblyReference" This property specifies the path to the placement model from the top-level assembly used by reference selections, if the placement model is not the top level assembly. This is necessary whenever external references are used for placement, or whenever the reference selections are made from a context outside of the placement model. | |
void | |
Set method for attribute "DependencyType" The dependency of the UDF. The choices correspond to the choices available when you create the UDF interactively. | |
void | |
Set method for attribute "DimDisplayType" These values correspond to the options in Creo Parametric for determining the appearance in the model of UDF dimensions and pattern parameters that were not variable in the UDF, and therefore cannot be modified in the model. | |
void | |
Set method for attribute "ExtReferences" This property is deprecated. To specify the path to the placement model from the top-level assembly used by reference selections use the AssemblyReference property. | |
void | SetInstanceName ( /*cipOptional*/ String value) |
Set method for attribute "InstanceName" If the UDF contains a family table, this field can be used to select which instance in that table is to be selected. If the UDF contains no family table, or if the generic instance is to be selected, the string should be empty. | |
void | |
Set method for attribute "Intersections" An array of intersections of the UDF and parts within the assembly. | |
void | |
Set method for attribute "Orientations" An array of orientations that provide the answers to Creo Parametric prompts that use a flip arrow. The order of orientations should correspond to the order in which Creo Parametric prompts for them when the UDF is created interactively. If you do not provide an orientation that Creo Parametric needs, it uses the default value ``no flip.'' | |
void | |
Set method for attribute "Quadrants" An array of points, which provide the X, Y, and Z coordinates that correspond to the picks answering the Creo Parametric prompts for the feature positions. The order of quadrants should correspond to the order in which Creo Parametric prompts for them when the UDF is created interactively. | |
void | |
Set method for attribute "References" An array of element references. | |
void | SetScale ( /*cipOptional*/ Double value) |
Set method for attribute "Scale" If the value of the ScaleType field is UDFSCALE_CUSTOM, this field is the user-defined scale factor. Otherwise, this field is ignored. | |
void | |
Set method for attribute "ScaleType" Specifies what should happen if the UDF used different length units than the model to which it is being applied. | |
void | |
Set method for attribute "VariantValues" An array of variable dimensions and pattern parameters |
Method Detail
GetInstanceName | ||
/*cipOptional*/ String | GetInstanceName | () |
SetInstanceName | ||
void | SetInstanceName | ( /*cipOptional*/ String value) |
If the UDF contains a family table, this field can be used to select which instance in that table is to be selected. If the UDF contains no family table, or if the generic instance is to be selected, the string should be empty.
User Guide References:
GetDependencyType | ||
/*cipOptional*/ UDFDependencyType | GetDependencyType | () |
SetDependencyType | ||
void | SetDependencyType |
The dependency of the UDF. The choices correspond to the choices available when you create the UDF interactively.
User Guide References:
GetScaleType | ||
/*cipOptional*/ UDFScaleType | GetScaleType | () |
SetScaleType | ||
void | SetScaleType |
Specifies what should happen if the UDF used different length units than the model to which it is being applied.
User Guide References:
GetScale | ||
/*cipOptional*/ Double | GetScale | () |
SetScale | ||
void | SetScale | ( /*cipOptional*/ Double value) |
If the value of the ScaleType field is UDFSCALE_CUSTOM, this field is the user-defined scale factor. Otherwise, this field is ignored.
User Guide References:
GetVariantValues | ||
/*cipOptional*/ UDFVariantValues | GetVariantValues | () |
SetVariantValues | ||
void | SetVariantValues |
An array of variable dimensions and pattern parameters
User Guide References:
GetDimDisplayType | ||
/*cipOptional*/ UDFDimensionDisplayType | GetDimDisplayType | () |
SetDimDisplayType | ||
void | SetDimDisplayType |
These values correspond to the options in Creo Parametric for determining the appearance in the model of UDF dimensions and pattern parameters that were not variable in the UDF, and therefore cannot be modified in the model.
User Guide References:
GetReferences | ||
/*cipOptional*/ UDFReferences | GetReferences | () |
SetReferences | ||
void | SetReferences |
An array of element references.
User Guide References:
GetIntersections | ||
/*cipOptional*/ UDFAssemblyIntersections | GetIntersections | () |
SetIntersections | ||
void | SetIntersections |
An array of intersections of the UDF and parts within the assembly.
User Guide References:
GetOrientations | ||
/*cipOptional*/ UDFOrientations | GetOrientations | () |
SetOrientations | ||
void | SetOrientations |
An array of orientations that provide the answers to Creo Parametric prompts that use a flip arrow. The order of orientations should correspond to the order in which Creo Parametric prompts for them when the UDF is created interactively. If you do not provide an orientation that Creo Parametric needs, it uses the default value ``no flip.''
User Guide References:
GetQuadrants | ||
/*cipOptional*/ Point3Ds | GetQuadrants | () |
SetQuadrants | ||
void | SetQuadrants |
An array of points, which provide the X, Y, and Z coordinates that correspond to the picks answering the Creo Parametric prompts for the feature positions. The order of quadrants should correspond to the order in which Creo Parametric prompts for them when the UDF is created interactively.
User Guide References:
GetAssemblyReference | ||
/*cipOptional*/ ComponentPath | GetAssemblyReference | () |
SetAssemblyReference | ||
void | SetAssemblyReference |
This property specifies the path to the placement model from the top-level assembly used by reference selections, if the placement model is not the top level assembly. This is necessary whenever external references are used for placement, or whenever the reference selections are made from a context outside of the placement model.
GetExtReferences | ||
/*cipOptional*/ UDFExternalReferences | GetExtReferences | () |
SetExtReferences | ||
void | SetExtReferences |
This property is deprecated. To specify the path to the placement model from the top-level assembly used by reference selections use the AssemblyReference property.
If one or more valid component path is supplied for this property, and null is supplied for the AssemblyReference property, the first component path supplied will be used for the AssemblyReference path.