
Public Member Functions | |
override void | Dispose () |
override bool | Empty () |
Indicates whether this ImportOptionsKit has any values set on it. More... | |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.Sketchup.ImportOptionsKit in_kit) |
Check if the source ImportOptionsKit is equivalent to this ImportOptionsKit. More... | |
override int | GetHashCode () |
ImportOptionsKit () | |
The default constructor creates an empty ImportOptionsKit object. More... | |
ImportOptionsKit (HPS.Sketchup.ImportOptionsKit in_kit) | |
The copy constructor creates a new ImportOptionsKit object that contains the same settings as the source ImportOptionsKit. More... | |
override HPS.Type | ObjectType () |
void | Set (HPS.Sketchup.ImportOptionsKit in_kit) |
Copies the source ImportOptionsKit into this ImportOptionsKit. More... | |
HPS.Sketchup.ImportOptionsKit | SetHiddenData (bool in_state) |
Sets whether to import hidden data from the SketchUp file. Defaults to false. More... | |
HPS.Sketchup.ImportOptionsKit | SetMetaData (bool in_state) |
Sets whether to import metadata from the SketchUp file. Defaults to false. More... | |
HPS.Sketchup.ImportOptionsKit | SetPortfolio (HPS.PortfolioKey in_portfolio) |
Sets the PortfolioKey where the SketchUp data will be imported into. If no segments are specified, root segments will be created for this purpose during import. More... | |
HPS.Sketchup.ImportOptionsKit | SetTarget (HPS.SegmentKey in_target, HPS.SegmentKey in_library) |
Sets the root and library segments where the SketchUp data will be imported into. If no segments are specified, root segments will be created for this purpose during import. More... | |
HPS.Sketchup.ImportOptionsKit | SetTarget (HPS.Model in_model) |
Uses the Model to set the root segment, library segment, and portfolio where the SketchUp data will be imported into. More... | |
HPS.Sketchup.ImportOptionsKit | SetView (HPS.View in_view) |
Sets the View where the default SketchUp camera will be imported into. If no View provided, camera can be retrieved via ImportResultsKit.ShowMainCamera. More... | |
void | Show (out HPS.Sketchup.ImportOptionsKit out_kit) |
Copies this ImportOptionsKit into the given ImportOptionsKit. More... | |
bool | ShowHiddenData (out bool out_state) |
Shows whether to import hidden data from the SketchUp file. Defaults to false. More... | |
bool | ShowMetaData (out bool out_state) |
Shows whether to import metadata from the SketchUp file. Defaults to false. More... | |
bool | ShowPortfolio (out HPS.PortfolioKey out_portfolio) |
Shows the PortfolioKey where the SketchUp data will be imported into. If no segments are specified, root segments will be created for this purpose during import. More... | |
bool | ShowTarget (out HPS.SegmentKey out_target, out HPS.SegmentKey out_library) |
Shows the root and library segments where the SketchUp data will be imported into. If no segments are specified, root segments will be created for this purpose during import. More... | |
bool | ShowTarget (out HPS.Model out_model) |
Shows the root and library segments and portfolio where the SketchUp data will be imported into. If no segments are specified, root segments will be created for this purpose during import. More... | |
bool | ShowView (out HPS.View out_view) |
Shows the view where the SketchUp camera will be imported into. More... | |
HPS.Sketchup.ImportOptionsKit | UnsetEverything () |
Removes all settings from this ImportOptionsKit. More... | |
HPS.Sketchup.ImportOptionsKit | UnsetHiddenData () |
Removes the Hidden data import state. More... | |
HPS.Sketchup.ImportOptionsKit | UnsetMetaData () |
Removes the metadata import state. More... | |
HPS.Sketchup.ImportOptionsKit | UnsetPortfolio () |
Removes the Portfolio import state. More... | |
HPS.Sketchup.ImportOptionsKit | UnsetTarget () |
Removes the target and library segments, and Model import state. More... | |
HPS.Sketchup.ImportOptionsKit | UnsetView () |
Removes the View import 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.Sketchup.ImportOptionsKit | GetDefault () |
Creates an ImportOptionsKit 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.Import. More... | |
static bool | operator!= (HPS.Sketchup.ImportOptionsKit a, HPS.Sketchup.ImportOptionsKit b) |
static bool | operator== (HPS.Sketchup.ImportOptionsKit a, HPS.Sketchup.ImportOptionsKit b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
Detailed Description
The ImportOptionsKit class is a user space object. It contains settings controlling what and how data is imported via Sketchup.
Constructor & Destructor Documentation
|
inline |
The default constructor creates an empty ImportOptionsKit object.
|
inline |
The copy constructor creates a new ImportOptionsKit object that contains the same settings as the source ImportOptionsKit.
- Parameters
-
in_kit The source ImportOptionsKit to copy.
Member Function Documentation
|
inlinevirtual |
Indicates whether this ImportOptionsKit has any values set on it.
- Returns
- true if no values are set on this ImportOptionsKit, false otherwise.
Reimplemented from HPS.Object.
|
inline |
Check if the source ImportOptionsKit is equivalent to this ImportOptionsKit.
- Parameters
-
in_kit The source ImportOptionsKit to compare to this ImportOptionsKit.
- Returns
- true if the objects are equivalent, false otherwise.
|
inlinestatic |
Creates an ImportOptionsKit 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.Import.
- Returns
- An ImportOptionsKit with the default settings.
|
inline |
Copies the source ImportOptionsKit into this ImportOptionsKit.
- Parameters
-
in_kit The source ImportOptionsKit to copy.
|
inline |
Sets whether to import hidden data from the SketchUp file. Defaults to false.
- Parameters
-
in_state Whether to import hidden data from the SketchUp file.
- Returns
- A reference to this ImportOptionsKit.
|
inline |
Sets whether to import metadata from the SketchUp file. Defaults to false.
- Parameters
-
in_state Whether to import metadata data from the SketchUp file.
- Returns
- A reference to this ImportOptionsKit.
|
inline |
Sets the PortfolioKey where the SketchUp data will be imported into. If no segments are specified, root segments will be created for this purpose during import.
- Parameters
-
in_portfolio Portfolio the SketchUp data will be imported into.
- Returns
- A reference to this ImportOptionsKit.
|
inline |
Sets the root and library segments where the SketchUp data will be imported into. If no segments are specified, root segments will be created for this purpose during import.
- Parameters
-
in_target Segment the SketchUp data will be imported into. in_library Segment the SketchUp includes data will be imported into.
- Returns
- A reference to this ImportOptionsKit.
|
inline |
Uses the Model to set the root segment, library segment, and portfolio where the SketchUp data will be imported into.
- Parameters
-
in_model Model to use to implicitly set Segment, Library and Portfolio the SketchUp data will be imported into.
- Returns
- A reference to this ImportOptionsKit.
|
inline |
Sets the View where the default SketchUp camera will be imported into. If no View provided, camera can be retrieved via ImportResultsKit.ShowMainCamera.
- Parameters
-
in_view View where SketchUp camera will be imported into.
- Returns
- A reference to this ImportOptionsKit.
|
inline |
Copies this ImportOptionsKit into the given ImportOptionsKit.
- Parameters
-
out_kit The ImportOptionsKit to populate with the contents of this ImportOptionsKit.
|
inline |
Shows whether to import hidden data from the SketchUp file. Defaults to false.
- Parameters
-
out_state Whether to import hidden data from the SketchUp file.
- Returns
- A reference to this ImportOptionsKit.
|
inline |
Shows whether to import metadata from the SketchUp file. Defaults to false.
- Parameters
-
out_state Whether to import metadata data from the SketchUp file.
- Returns
- A reference to this ImportOptionsKit.
|
inline |
Shows the PortfolioKey where the SketchUp data will be imported into. If no segments are specified, root segments will be created for this purpose during import.
- Parameters
-
out_portfolio Portfolio the SketchUp data will be imported into.
- Returns
- A reference to this ImportOptionsKit.
|
inline |
Shows the root and library segments where the SketchUp data will be imported into. If no segments are specified, root segments will be created for this purpose during import.
- Parameters
-
out_target Segment the SketchUp data will be imported into. out_library Segment the SketchUp includes data will be imported into.
- Returns
- A reference to this ImportOptionsKit.
|
inline |
Shows the root and library segments and portfolio where the SketchUp data will be imported into. If no segments are specified, root segments will be created for this purpose during import.
- Parameters
-
out_model Model to use to implicitly set Segment, Library and Portfolio the SketchUp data will be imported into.
- Returns
- A reference to this ImportOptionsKit.
|
inline |
Shows the view where the SketchUp camera will be imported into.
- Parameters
-
out_view View where SketchUp camera will be imported into.
- Returns
- A reference to this ImportOptionsKit.
|
inline |
Removes all settings from this ImportOptionsKit.
- Returns
- A reference to this ImportOptionsKit.
|
inline |
Removes the Hidden data import state.
- Returns
- A reference to this ImportOptionsKit.
|
inline |
Removes the metadata import state.
- Returns
- A reference to this ImportOptionsKit.
|
inline |
Removes the Portfolio import state.
- Returns
- A reference to this ImportOptionsKit.
|
inline |
Removes the target and library segments, and Model import state.
- Returns
- A reference to this ImportOptionsKit.
|
inline |
Removes the View import state.
- Returns
- A reference to this ImportOptionsKit.
The documentation for this class was generated from the following file:
- internals/hps_sprk_sketchup/source/cs/HPS.Sketchup.cs