
Public Member Functions | |
override void | Dispose () |
override bool | Empty () |
Indicates whether this ExportOptionsKit has any values set on it. More... | |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.Parasolid.ExportOptionsKit in_kit) |
Check if the source ExportOptionsKit is equivalent to this ExportOptionsKit. More... | |
ExportOptionsKit () | |
The default constructor creates an empty ExportOptionsKit object. More... | |
ExportOptionsKit (HPS.Parasolid.ExportOptionsKit in_kit) | |
The copy constructor creates a new ExportOptionsKit object that contains the same settings as the source ExportOptionsKit. More... | |
override int | GetHashCode () |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object). More... | |
void | Set (HPS.Parasolid.ExportOptionsKit in_kit) |
Copies the source ExportOptionsKit into this ExportOptionsKit. More... | |
HPS.Parasolid.ExportOptionsKit | SetFormat (HPS.Parasolid.Format in_format) |
Sets the format type to be exported. This corresponds to the value that will be passed to PK_PART_transmit_o_t.transmit_format. More... | |
HPS.Parasolid.ExportOptionsKit | SetUserFields (bool in_export_user_fields) |
Sets whether to export user fields from the CAD file. This corresponds to the value that will be passed to PK_PART_transmit_o_t.receive_user_fields. More... | |
void | Show (out HPS.Parasolid.ExportOptionsKit out_kit) |
Copies this ExportOptionsKit into the given ExportOptionsKit. More... | |
bool | ShowFormat (out HPS.Parasolid.Format out_format) |
Shows the format export setting. More... | |
bool | ShowUserFields (out bool out_user_fields) |
Shows the user fields export setting. More... | |
HPS.Parasolid.ExportOptionsKit | UnsetEverything () |
Removes all settings from this ExportOptionsKit. More... | |
HPS.Parasolid.ExportOptionsKit | UnsetFormat () |
Removes the format export state. More... | |
HPS.Parasolid.ExportOptionsKit | UnsetUserFields () |
Removes the user fields export state. More... | |
![]() | |
SprocketKit (HPS.SprocketKit in_that) | |
![]() | |
Sprocket (HPS.Sprocket in_that) | |
![]() | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns the object's database handle, which can be used to determine which instance of a class the object is. For example, controls are simply aliases for segment keys that group related functions. Therefore, a SegmentKey and all of its controls would return the same instance id. Different keys and controls will return the same value if they are backed by the same database resource. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object that) | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
virtual HPS.Type | Type () |
This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types. More... | |
Static Public Member Functions | |
static HPS.Parasolid.ExportOptionsKit | GetDefault () |
Creates an ExportOptionsKit which contains the default settings. The returned object will not necessarily have values set for every option, but it will have settings for those options where it is reasonable to have a default. These values will be used for import unless an option is overridden by the options passed to File.Export. More... | |
static bool | operator!= (HPS.Parasolid.ExportOptionsKit a, HPS.Parasolid.ExportOptionsKit b) |
static bool | operator== (HPS.Parasolid.ExportOptionsKit a, HPS.Parasolid.ExportOptionsKit b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
Detailed Description
The ExportOptionsKit class is a user space object. It contains settings controlling what and how data is exported via Parasolid. Default values for the various fields of this class can be found here.
Constructor & Destructor Documentation
|
inline |
The default constructor creates an empty ExportOptionsKit object.
|
inline |
The copy constructor creates a new ExportOptionsKit object that contains the same settings as the source ExportOptionsKit.
- Parameters
-
in_kit The source ExportOptionsKit to copy.
Member Function Documentation
|
inlinevirtual |
Indicates whether this ExportOptionsKit has any values set on it.
- Returns
- true if no values are set on this ExportOptionsKit, false otherwise.
Reimplemented from HPS.Object.
|
inline |
Check if the source ExportOptionsKit is equivalent to this ExportOptionsKit.
- Parameters
-
in_kit The source ExportOptionsKit to compare to this ExportOptionsKit.
- Returns
- true if the objects are equivalent, false otherwise.
|
inlinestatic |
Creates an ExportOptionsKit which contains the default settings. The returned object will not necessarily have values set for every option, but it will have settings for those options where it is reasonable to have a default. These values will be used for import unless an option is overridden by the options passed to File.Export.
- Returns
- An ExportOptionsKit with the default settings.
|
inlinevirtual |
This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).
- Returns
- The declared type of the object in question, which may differ from the true, underlying type.
Reimplemented from HPS.SprocketKit.
|
inline |
Copies the source ExportOptionsKit into this ExportOptionsKit.
- Parameters
-
in_kit The source ExportOptionsKit to copy.
|
inline |
Sets the format type to be exported. This corresponds to the value that will be passed to PK_PART_transmit_o_t.transmit_format.
- Parameters
-
in_format The format of the file to be exported.
- Returns
- A reference to this ExportOptionsKit.
Default value
|
inline |
Sets whether to export user fields from the CAD file. This corresponds to the value that will be passed to PK_PART_transmit_o_t.receive_user_fields.
- Parameters
-
in_export_user_fields Whether to export user fields from the CAD file.
- Returns
- A reference to this ExportOptionsKit.
|
inline |
Copies this ExportOptionsKit into the given ExportOptionsKit.
- Parameters
-
out_kit The ExportOptionsKit to populate with the contents of this ExportOptionsKit.
|
inline |
Shows the format export setting.
- Parameters
-
out_format The format setting for this export.
- Returns
- true if a format setting was specified, false otherwise.
|
inline |
Shows the user fields export setting.
- Parameters
-
out_user_fields The user fields setting for this export.
- Returns
- true if a user fields setting was specified, false otherwise.
|
inline |
Removes all settings from this ExportOptionsKit.
- Returns
- A reference to this ExportOptionsKit.
|
inline |
Removes the format export state.
- Returns
- A reference to this ExportOptionsKit.
|
inline |
Removes the user fields export state.
- Returns
- A reference to this ExportOptionsKit.
The documentation for this class was generated from the following file:
- internals/hps_sprk_parasolid/source/cs/HPS.Parasolid.cs