CIP JAVA documentation for class "com.ptc.pfc.pfcUDFCreate.UDFCustomCreateInstructions"

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

Method Summary
`/optional/ ComponentPath`	`GetAssemblyReference ()` 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.
`/optional/ UDFDependencyType`	`GetDependencyType ()` Get method for attribute "DependencyType" The dependency of the UDF. The choices correspond to the choices available when you create the UDF interactively.
`/optional/ UDFDimensionDisplayType`	`GetDimDisplayType ()` 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.
`/optional/ UDFExternalReferences`	`GetExtReferences ()` 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.
`/optional/ String`	`GetInstanceName ()` 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.
`/optional/ UDFAssemblyIntersections`	`GetIntersections ()` Get method for attribute "Intersections" An array of intersections of the UDF and parts within the assembly.
`/optional/ UDFOrientations`	`GetOrientations ()` 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.''
`/optional/ 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.
`/optional/ UDFReferences`	`GetReferences ()` Get method for attribute "References" An array of element references.
`/optional/ 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.
`/optional/ 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.
`/optional/ UDFVariantValues`	`GetVariantValues ()` Get method for attribute "VariantValues" An array of variable dimensions and pattern parameters
`void`	`SetAssemblyReference ( /optional/ ComponentPath value)` 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`	`SetDependencyType ( /optional/ UDFDependencyType value)` Set method for attribute "DependencyType" The dependency of the UDF. The choices correspond to the choices available when you create the UDF interactively.
`void`	`SetDimDisplayType ( /optional/ UDFDimensionDisplayType value)` 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`	`SetExtReferences ( /optional/ UDFExternalReferences value)` 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 ( /optional/ 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`	`SetIntersections ( /optional/ UDFAssemblyIntersections value)` Set method for attribute "Intersections" An array of intersections of the UDF and parts within the assembly.
`void`	`SetOrientations ( /optional/ UDFOrientations value)` 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`	`SetQuadrants ( /optional/ Point3Ds value)` 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`	`SetReferences ( /optional/ UDFReferences value)` Set method for attribute "References" An array of element references.
`void`	`SetScale ( /optional/ 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`	`SetScaleType ( /optional/ UDFScaleType value)` 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`	`SetVariantValues ( /optional/ UDFVariantValues value)` Set method for attribute "VariantValues" An array of variable dimensions and pattern parameters

Methods Inherited from Interface `com.ptc.pfc.pfcUDFGroup.UDFGroupCreateInstructions`
`GetName`, `SetName`, `GetShowUDFEditMenu`, `SetShowUDFEditMenu`, `GetShowModifyNCSeqMenu`, `SetShowModifyNCSeqMenu`, `GetUseExistingTools`, `SetUseExistingTools`, `GetTurnOffUDFRedefineMenu`, `SetTurnOffUDFRedefineMenu`, `GetTurnOffFixModelUI`, `SetTurnOffFixModelUI`

Method Detail

GetInstanceName/SetInstanceName

`/optional/ String`	`GetInstanceName`	`()`
`void`	`SetInstanceName`	`( /optional/ 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.

Manual References:: Features: Creating a Custom UDF, Features: Creating a Custom UDF

GetDependencyType/SetDependencyType

`/optional/ UDFDependencyType`	`GetDependencyType`	`()`
`void`	`SetDependencyType`	`( /optional/ UDFDependencyType value)`

The dependency of the UDF. The choices correspond to the choices available when you create the UDF interactively.

Manual References:: Features: Creating a Custom UDF, Features: Creating a Custom UDF

GetScaleType/SetScaleType

`/optional/ UDFScaleType`	`GetScaleType`	`()`
`void`	`SetScaleType`	`( /optional/ UDFScaleType value)`

Specifies what should happen if the UDF used different length units than the model to which it is being applied.

Manual References:: Features: Creating a Custom UDF, Features: Creating a Custom UDF

GetScale/SetScale

`/optional/ Double`	`GetScale`	`()`
`void`	`SetScale`	`( /optional/ 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.

Manual References:: Features: Creating a Custom UDF, Features: Creating a Custom UDF

GetVariantValues/SetVariantValues

`/optional/ UDFVariantValues`	`GetVariantValues`	`()`
`void`	`SetVariantValues`	`( /optional/ UDFVariantValues value)`

An array of variable dimensions and pattern parameters

Manual References:: Features: Creating a Custom UDF, Features: Creating a Custom UDF

GetDimDisplayType/SetDimDisplayType

`/optional/ UDFDimensionDisplayType`	`GetDimDisplayType`	`()`
`void`	`SetDimDisplayType`	`( /optional/ UDFDimensionDisplayType value)`

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.

Manual References:: Features: Creating a Custom UDF, Features: Creating a Custom UDF

GetReferences/SetReferences

`/optional/ UDFReferences`	`GetReferences`	`()`
`void`	`SetReferences`	`( /optional/ UDFReferences value)`

An array of element references.

Manual References:: Features: Creating a Custom UDF

GetIntersections/SetIntersections

`/optional/ UDFAssemblyIntersections`	`GetIntersections`	`()`
`void`	`SetIntersections`	`( /optional/ UDFAssemblyIntersections value)`

An array of intersections of the UDF and parts within the assembly.

Manual References:: Features: Creating a Custom UDF

GetOrientations/SetOrientations

`/optional/ UDFOrientations`	`GetOrientations`	`()`
`void`	`SetOrientations`	`( /optional/ UDFOrientations value)`

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.''

Manual References:: Features: Creating a Custom UDF, Features: Creating a Custom UDF

GetQuadrants/SetQuadrants

`/optional/ Point3Ds`	`GetQuadrants`	`()`
`void`	`SetQuadrants`	`( /optional/ Point3Ds value)`

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.

Manual References:: Features: Creating a Custom UDF

GetAssemblyReference/SetAssemblyReference

`/optional/ ComponentPath`	`GetAssemblyReference`	`()`
`void`	`SetAssemblyReference`	`( /optional/ ComponentPath value)`

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/SetExtReferences

`/optional/ UDFExternalReferences`	`GetExtReferences`	`()`
`void`	`SetExtReferences`	`( /optional/ UDFExternalReferences value)`

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.

Manual References:: Features: Creating a Custom UDF