Inheritance diagram for HPS.Sketchup.ImportOptionsKit:
HPS.SprocketKit HPS.Sprocket HPS.Object

Public Member Functions

override void Dispose ()
 
override bool Empty ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.Sketchup.ImportOptionsKit in_kit)
 
override int GetHashCode ()
 
 ImportOptionsKit ()
 
 ImportOptionsKit (HPS.Sketchup.ImportOptionsKit in_kit)
 
override HPS.Type ObjectType ()
 
void Set (HPS.Sketchup.ImportOptionsKit in_kit)
 
HPS.Sketchup.ImportOptionsKit SetHiddenData (bool in_state)
 
HPS.Sketchup.ImportOptionsKit SetMetaData (bool in_state)
 
HPS.Sketchup.ImportOptionsKit SetPortfolio (HPS.PortfolioKey in_portfolio)
 
HPS.Sketchup.ImportOptionsKit SetTarget (HPS.SegmentKey in_target, HPS.SegmentKey in_library)
 
HPS.Sketchup.ImportOptionsKit SetTarget (HPS.Model in_model)
 
HPS.Sketchup.ImportOptionsKit SetView (HPS.View in_view)
 
void Show (out HPS.Sketchup.ImportOptionsKit out_kit)
 
bool ShowHiddenData (out bool out_state)
 
bool ShowMetaData (out bool out_state)
 
bool ShowPortfolio (out HPS.PortfolioKey out_portfolio)
 
bool ShowTarget (out HPS.SegmentKey out_target, out HPS.SegmentKey out_library)
 
bool ShowTarget (out HPS.Model out_model)
 
bool ShowView (out HPS.View out_view)
 
HPS.Sketchup.ImportOptionsKit UnsetEverything ()
 
HPS.Sketchup.ImportOptionsKit UnsetHiddenData ()
 
HPS.Sketchup.ImportOptionsKit UnsetMetaData ()
 
HPS.Sketchup.ImportOptionsKit UnsetPortfolio ()
 
HPS.Sketchup.ImportOptionsKit UnsetTarget ()
 
HPS.Sketchup.ImportOptionsKit UnsetView ()
 
- Public Member Functions inherited from HPS.SprocketKit
SprocketKit (HPS.SprocketKit in_that)
 
- Public Member Functions inherited from HPS.Sprocket
Sprocket (HPS.Sprocket in_that)
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
Object (HPS.Object that)
 
virtual void Reset ()
 
virtual HPS.Type Type ()
 

Static Public Member Functions

static HPS.Sketchup.ImportOptionsKit GetDefault ()
 
static bool operator!= (HPS.Sketchup.ImportOptionsKit a, HPS.Sketchup.ImportOptionsKit b)
 
static bool operator== (HPS.Sketchup.ImportOptionsKit a, HPS.Sketchup.ImportOptionsKit b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Protected Attributes inherited from HPS.Object
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

◆ ImportOptionsKit() [1/2]

HPS.Sketchup.ImportOptionsKit.ImportOptionsKit ( )
inline

The default constructor creates an empty ImportOptionsKit object.

◆ ImportOptionsKit() [2/2]

HPS.Sketchup.ImportOptionsKit.ImportOptionsKit ( HPS.Sketchup.ImportOptionsKit  in_kit)
inline

The copy constructor creates a new ImportOptionsKit object that contains the same settings as the source ImportOptionsKit.

Parameters
in_kitThe source ImportOptionsKit to copy.

Member Function Documentation

◆ Empty()

override bool HPS.Sketchup.ImportOptionsKit.Empty ( )
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.

◆ Equals()

bool HPS.Sketchup.ImportOptionsKit.Equals ( HPS.Sketchup.ImportOptionsKit  in_kit)
inline

Check if the source ImportOptionsKit is equivalent to this ImportOptionsKit.

Parameters
in_kitThe source ImportOptionsKit to compare to this ImportOptionsKit.
Returns
true if the objects are equivalent, false otherwise.

◆ GetDefault()

static HPS.Sketchup.ImportOptionsKit HPS.Sketchup.ImportOptionsKit.GetDefault ( )
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.

◆ ObjectType()

override HPS.Type HPS.Sketchup.ImportOptionsKit.ObjectType ( )
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.

◆ Set()

void HPS.Sketchup.ImportOptionsKit.Set ( HPS.Sketchup.ImportOptionsKit  in_kit)
inline

Copies the source ImportOptionsKit into this ImportOptionsKit.

Parameters
in_kitThe source ImportOptionsKit to copy.

◆ SetHiddenData()

HPS.Sketchup.ImportOptionsKit HPS.Sketchup.ImportOptionsKit.SetHiddenData ( bool  in_state)
inline

Sets whether to import hidden data from the SketchUp file. Defaults to false.

Parameters
in_stateWhether to import hidden data from the SketchUp file.
Returns
A reference to this ImportOptionsKit.

◆ SetMetaData()

HPS.Sketchup.ImportOptionsKit HPS.Sketchup.ImportOptionsKit.SetMetaData ( bool  in_state)
inline

Sets whether to import metadata from the SketchUp file. Defaults to false.

Parameters
in_stateWhether to import metadata data from the SketchUp file.
Returns
A reference to this ImportOptionsKit.

◆ SetPortfolio()

HPS.Sketchup.ImportOptionsKit HPS.Sketchup.ImportOptionsKit.SetPortfolio ( HPS.PortfolioKey  in_portfolio)
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_portfolioPortfolio the SketchUp data will be imported into.
Returns
A reference to this ImportOptionsKit.

◆ SetTarget() [1/2]

HPS.Sketchup.ImportOptionsKit HPS.Sketchup.ImportOptionsKit.SetTarget ( HPS.SegmentKey  in_target,
HPS.SegmentKey  in_library 
)
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_targetSegment the SketchUp data will be imported into.
in_librarySegment the SketchUp includes data will be imported into.
Returns
A reference to this ImportOptionsKit.

◆ SetTarget() [2/2]

HPS.Sketchup.ImportOptionsKit HPS.Sketchup.ImportOptionsKit.SetTarget ( HPS.Model  in_model)
inline

Uses the Model to set the root segment, library segment, and portfolio where the SketchUp data will be imported into.

Parameters
in_modelModel to use to implicitly set Segment, Library and Portfolio the SketchUp data will be imported into.
Returns
A reference to this ImportOptionsKit.

◆ SetView()

HPS.Sketchup.ImportOptionsKit HPS.Sketchup.ImportOptionsKit.SetView ( HPS.View  in_view)
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_viewView where SketchUp camera will be imported into.
Returns
A reference to this ImportOptionsKit.

◆ Show()

void HPS.Sketchup.ImportOptionsKit.Show ( out HPS.Sketchup.ImportOptionsKit  out_kit)
inline

Copies this ImportOptionsKit into the given ImportOptionsKit.

Parameters
out_kitThe ImportOptionsKit to populate with the contents of this ImportOptionsKit.

◆ ShowHiddenData()

bool HPS.Sketchup.ImportOptionsKit.ShowHiddenData ( out bool  out_state)
inline

Shows whether to import hidden data from the SketchUp file. Defaults to false.

Parameters
out_stateWhether to import hidden data from the SketchUp file.
Returns
A reference to this ImportOptionsKit.

◆ ShowMetaData()

bool HPS.Sketchup.ImportOptionsKit.ShowMetaData ( out bool  out_state)
inline

Shows whether to import metadata from the SketchUp file. Defaults to false.

Parameters
out_stateWhether to import metadata data from the SketchUp file.
Returns
A reference to this ImportOptionsKit.

◆ ShowPortfolio()

bool HPS.Sketchup.ImportOptionsKit.ShowPortfolio ( out HPS.PortfolioKey  out_portfolio)
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_portfolioPortfolio the SketchUp data will be imported into.
Returns
A reference to this ImportOptionsKit.

◆ ShowTarget() [1/2]

bool HPS.Sketchup.ImportOptionsKit.ShowTarget ( out HPS.SegmentKey  out_target,
out HPS.SegmentKey  out_library 
)
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_targetSegment the SketchUp data will be imported into.
out_librarySegment the SketchUp includes data will be imported into.
Returns
A reference to this ImportOptionsKit.

◆ ShowTarget() [2/2]

bool HPS.Sketchup.ImportOptionsKit.ShowTarget ( out HPS.Model  out_model)
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_modelModel to use to implicitly set Segment, Library and Portfolio the SketchUp data will be imported into.
Returns
A reference to this ImportOptionsKit.

◆ ShowView()

bool HPS.Sketchup.ImportOptionsKit.ShowView ( out HPS.View  out_view)
inline

Shows the view where the SketchUp camera will be imported into.

Parameters
out_viewView where SketchUp camera will be imported into.
Returns
A reference to this ImportOptionsKit.

◆ UnsetEverything()

HPS.Sketchup.ImportOptionsKit HPS.Sketchup.ImportOptionsKit.UnsetEverything ( )
inline

Removes all settings from this ImportOptionsKit.

Returns
A reference to this ImportOptionsKit.

◆ UnsetHiddenData()

HPS.Sketchup.ImportOptionsKit HPS.Sketchup.ImportOptionsKit.UnsetHiddenData ( )
inline

Removes the Hidden data import state.

Returns
A reference to this ImportOptionsKit.

◆ UnsetMetaData()

HPS.Sketchup.ImportOptionsKit HPS.Sketchup.ImportOptionsKit.UnsetMetaData ( )
inline

Removes the metadata import state.

Returns
A reference to this ImportOptionsKit.

◆ UnsetPortfolio()

HPS.Sketchup.ImportOptionsKit HPS.Sketchup.ImportOptionsKit.UnsetPortfolio ( )
inline

Removes the Portfolio import state.

Returns
A reference to this ImportOptionsKit.

◆ UnsetTarget()

HPS.Sketchup.ImportOptionsKit HPS.Sketchup.ImportOptionsKit.UnsetTarget ( )
inline

Removes the target and library segments, and Model import state.

Returns
A reference to this ImportOptionsKit.

◆ UnsetView()

HPS.Sketchup.ImportOptionsKit HPS.Sketchup.ImportOptionsKit.UnsetView ( )
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