HPS.Sketchup.ImportResultsKit

class HPS.Sketchup.ImportResultsKit : public HPS.SprocketKit

The ImportResultsKit class contains the results of a successful SketchUp import.

Public Functions

override bool Empty ()

Indicates whether this ImportResultsKit has any values set on it.

Return

true if no values are set on this ImportResultsKit, false otherwise.

bool Equals (HPS.Sketchup.ImportResultsKit in_kit)

Check if the source ImportResultsKit is equivalent to this ImportResultsKit.

Param in_kit

The source ImportResultsKit to compare to this ImportResultsKit.

Return

true if the objects are equivalent, false otherwise.

ImportResultsKit ()

The default constructor creates an empty ImportResultsKit object.

ImportResultsKit (HPS.Sketchup.ImportResultsKit in_kit)

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

Param in_kit

The source ImportResultsKit to copy.

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

Return

The declared type of the object in question, which may differ from the true, underlying type.

void Set (HPS.Sketchup.ImportResultsKit in_kit)

Copies the source ImportResultsKit into this ImportResultsKit.

Param in_kit

The source ImportResultsKit to copy.

void Show (out HPS.Sketchup.ImportResultsKit out_kit)

Copies this ImportResultsKit into the given ImportResultsKit.

Param out_kit

The ImportResultsKit to populate with the contents of this ImportResultsKit.

bool ShowMainCamera (out HPS.CameraKit out_camera)

Shows the camera where the main SketchUp camera was imported into.

Param out_camera

CameraKit where main SketchUp camera was imported into

Return

true if a valid camera was imported, false otherwise.

bool ShowPortfolio (out HPS.PortfolioKey out_portfolio)

Shows the PortfolioKey where the SketchUp data was imported into.

Param out_portfolio

Portfolio the SketchUp data was imported into.

Return

true if a valid Portfolio is set, false otherwise.

bool ShowTarget (out HPS.Model out_model)

Shows the Model where the SketchUp data was imported into.

Param out_model

Model to use to implicitly set Segment, Library and Portfolio the SketchUp data will be imported into.

Return

true if a Model was specified on import, false otherwise.

bool ShowTarget (out HPS.SegmentKey out_target, out HPS.SegmentKey out_library)

Shows the root and library segments where the SketchUp data was imported into.

Param out_target

Segment the SketchUp data was imported into.

Param out_library

Segment the SketchUp includes data was imported into.

Return

true if a valid target and library segment are set, false otherwise.

bool ShowView (out HPS.View out_view)

Shows the view where the main SketchUp camera was imported into.

Param out_view

View where main SketchUp camera was imported into.

Return

true if a View was specified on import, false otherwise.