Library | Package Java Toolkit

Interface CoordSysExportInstructions

package com.ptc.pfc.pfcModel;

public interface CoordSysExportInstructions
  extends com.ptc.pfc.pfcModel.ExportInstructions



Description

Base class of classes that export files with information that describes faceted, solid models (without datums and surfaces).

For more information about the Maximum Chord Height and Angle Control settings, refer to information about controlling the quality of an export in the Interface section of the Creo Parametric help.
Direct Known Subclasses:
CATIAFacetsExportInstructions, RenderExportInstructions, STLASCIIExportInstructions, STLBinaryExportInstructions, InventorExportInstructions



Method Summary
/*optional*/ DoubleGetAngleControl ()
    Get method for attribute "AngleControl"
    The Angle Control setting. (Pass null if you specify Quality.). Default value is 0.1.
/*optional*/ StringGetCsysName ()
    Get method for attribute "CsysName"
    Stores the name of a coordinate-system feature in the model being exported. A coordinate system that places the part or assembly in its upper-right quadrant is recommended, so that all position/distance values are positive. Allowed to be null if exporting as Slice
/*optional*/ FacetControlFlagsGetFacetControlOptions ()
    Get method for attribute "FacetControlOptions"
    Flags (FACET_STEP_SIZE_ADJUST and others) to control Facet export. (Pass null if not exporting slice formats).
/*optional*/ DoubleGetMaxChordHeight ()
    Get method for attribute "MaxChordHeight"
    The Maximun Chord Height setting. (Pass null if you specify Quality.). Default value is 0.1.
/*optional*/ IntegerGetQuality ()
    Get method for attribute "Quality"
    Can be used in place of MaxChordHeight and AngleControl. A value between 1 and 10. The higher the value you pass, the lower the MaxChordHeight setting and the higher the AngleControl setting that the method will use.

Pass null if you use MaxChordHeight and AngleControl values. If Quality, MaxChordHeight, and AngleControl are all null, a Quality value of 3 is used. Default value is 1.0
/*optional*/ SliceExportDataGetSliceExportData ()
    Returns an SliceExportData object or NULL if the SliceExportData isn't set.
/*optional*/ DoubleGetStepSize ()
    Get method for attribute "StepSize"
    The Step Size Control setting. (Pass null if you specify Quality.). Default value is 0.0.
voidSetAngleControl ( /*optional*/ Double value)
    Set method for attribute "AngleControl"
    The Angle Control setting. (Pass null if you specify Quality.). Default value is 0.1.
voidSetCsysName ( /*optional*/ String value)
    Set method for attribute "CsysName"
    Stores the name of a coordinate-system feature in the model being exported. A coordinate system that places the part or assembly in its upper-right quadrant is recommended, so that all position/distance values are positive. Allowed to be null if exporting as Slice
voidSetFacetControlOptions ( /*optional*/ FacetControlFlags value)
    Set method for attribute "FacetControlOptions"
    Flags (FACET_STEP_SIZE_ADJUST and others) to control Facet export. (Pass null if not exporting slice formats).
voidSetMaxChordHeight ( /*optional*/ Double value)
    Set method for attribute "MaxChordHeight"
    The Maximun Chord Height setting. (Pass null if you specify Quality.). Default value is 0.1.
voidSetQuality ( /*optional*/ Integer value)
    Set method for attribute "Quality"
    Can be used in place of MaxChordHeight and AngleControl. A value between 1 and 10. The higher the value you pass, the lower the MaxChordHeight setting and the higher the AngleControl setting that the method will use.

Pass null if you use MaxChordHeight and AngleControl values. If Quality, MaxChordHeight, and AngleControl are all null, a Quality value of 3 is used. Default value is 1.0
voidSetSliceExportData ( /*optional*/ SliceExportData SliceExpData)
    Sets the SliceExportData .
voidSetStepSize ( /*optional*/ Double value)
    Set method for attribute "StepSize"
    The Step Size Control setting. (Pass null if you specify Quality.). Default value is 0.0.

Methods Inherited from Interface com.ptc.pfc.pfcModel.ExportInstructions
GetFileType

Method Detail

GetCsysName/SetCsysName

/*optional*/ StringGetCsysName ()
voidSetCsysName ( /*optional*/ String value)


    Stores the name of a coordinate-system feature in the model being exported. A coordinate system that places the part or assembly in its upper-right quadrant is recommended, so that all position/distance values are positive. Allowed to be null if exporting as Slice
Manual References:
Interface: Exporting Using Coordinate System, Interface: Exporting Using Coordinate System, Interface: Exporting Using Coordinate System, Interface: Exporting Using Coordinate System



GetQuality/SetQuality

/*optional*/ IntegerGetQuality ()
voidSetQuality ( /*optional*/ Integer value)


    Can be used in place of MaxChordHeight and AngleControl. A value between 1 and 10. The higher the value you pass, the lower the MaxChordHeight setting and the higher the AngleControl setting that the method will use.

Pass null if you use MaxChordHeight and AngleControl values. If Quality, MaxChordHeight, and AngleControl are all null, a Quality value of 3 is used. Default value is 1.0
Manual References:
Interface: Exporting Using Coordinate System, Interface: Exporting Using Coordinate System, Interface: Exporting Using Coordinate System, Interface: Exporting Using Coordinate System



GetMaxChordHeight/SetMaxChordHeight

/*optional*/ DoubleGetMaxChordHeight ()
voidSetMaxChordHeight ( /*optional*/ Double value)


    The Maximun Chord Height setting. (Pass null if you specify Quality.). Default value is 0.1.
Manual References:
Interface: Exporting Using Coordinate System, Interface: Exporting Using Coordinate System, Interface: Exporting Using Coordinate System, Interface: Exporting Using Coordinate System



GetAngleControl/SetAngleControl

/*optional*/ DoubleGetAngleControl ()
voidSetAngleControl ( /*optional*/ Double value)


    The Angle Control setting. (Pass null if you specify Quality.). Default value is 0.1.
Manual References:
Interface: Exporting Using Coordinate System, Interface: Exporting Using Coordinate System, Interface: Exporting Using Coordinate System, Interface: Exporting Using Coordinate System



GetStepSize/SetStepSize

/*optional*/ DoubleGetStepSize ()
voidSetStepSize ( /*optional*/ Double value)


    The Step Size Control setting. (Pass null if you specify Quality.). Default value is 0.0.
Manual References:
Interface: Exporting to Faceted Formats, Interface: Exporting Using Coordinate System, Interface: Exporting Using Coordinate System, Interface: Exporting to Faceted Formats, Interface: Exporting Using Coordinate System, Interface: Exporting Using Coordinate System



GetFacetControlOptions/SetFacetControlOptions

/*optional*/ FacetControlFlagsGetFacetControlOptions ()
voidSetFacetControlOptions ( /*optional*/ FacetControlFlags value)


    Flags (FACET_STEP_SIZE_ADJUST and others) to control Facet export. (Pass null if not exporting slice formats).
Manual References:
Interface: Exporting Using Coordinate System, Interface: Exporting Using Coordinate System, Interface: Exporting Using Coordinate System, Interface: Exporting Using Coordinate System



GetSliceExportData

/*optional*/ SliceExportDataGetSliceExportData ()


    Returns an SliceExportData object or NULL if the SliceExportData isn't set.
Manual References:
Interface: Exporting Using Coordinate System, Interface: Exporting Using Coordinate System
Returns:
The SliceExportData object.


SetSliceExportData

voidSetSliceExportData ( /*optional*/ SliceExportData SliceExpData)


    Sets the SliceExportData .
Manual References:
Interface: Exporting Using Coordinate System, Interface: Exporting Using Coordinate System
Parameters:
SliceExpData
The SliceExportData for setting.
Returns: