|
override void | deleteCptr () |
|
virtual IntPtr | GetNonDirectorClassID () |
|
|
bool | cMemOwn |
|
HandleRef | cptr |
|
The ImportResultsKit class contains the results of a successful HSF import.
◆ ImportResultsKit() [1/2]
HPS.Stream.ImportResultsKit.ImportResultsKit |
( |
| ) |
|
|
inline |
◆ ImportResultsKit() [2/2]
◆ Empty()
override bool HPS.Stream.ImportResultsKit.Empty |
( |
| ) |
|
|
inlinevirtual |
◆ Equals()
◆ ObjectType()
override HPS.Type HPS.Stream.ImportResultsKit.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.Kit.
◆ Set()
◆ SetAlternateRoot()
Sets the segment which was used when the import file tried to access segments above the root segment. This is really only used when generating an ImportResultsKit which is being returned to a user following an HSF import.
- Parameters
-
in_segment | Segment that was used when the import file tried to access segments above the root segment during import. |
- Returns
- A reference to this ImportResultsKit.
◆ SetDefaultCamera()
Sets the "default" camera for this ImportResultsKit. This is generally only used during a Stream Import to record the default camera read from the Stream file.
- Parameters
-
in_camera | The "default" named camera from the HSF file. |
- Returns
- A reference to this ImportResultsKit.
◆ SetPortfolio()
Sets the portfolio which was used for any definitions that had to be created during import. This is really only used when generating an ImportResultsKit which is being returned to a user following an HSF import.
- Parameters
-
in_portfolio | Portfolio that was used for any definitions that had to be created during import. |
- Returns
- A reference to this ImportResultsKit.
◆ SetSegment()
Sets the root segment which the HSF data was imported into. This is really only used when generating an ImportResultsKit which is being returned to a user following an HSF import.
- Parameters
-
in_segment | Segment the HSF data was imported into. |
- Returns
- A reference to this ImportResultsKit.
◆ Show()
◆ ShowAlternateRoot()
bool HPS.Stream.ImportResultsKit.ShowAlternateRoot |
( |
out HPS.SegmentKey |
out_segment | ) |
|
|
inline |
Shows the segment which was used when the import file tried to access segments above the root segment. This was either the alternate root specified by the user in the ImportOptionsKit passed to Stream.File.Import, or the root segment that was created for this purpose during import.
- Parameters
-
out_segment | Segment that was used when the import file tried to access segments above the root segment. |
- Returns
- true if an alternate root segment was specified, false otherwise.
◆ ShowDefaultCamera()
bool HPS.Stream.ImportResultsKit.ShowDefaultCamera |
( |
out HPS.CameraKit |
out_camera | ) |
|
|
inline |
Shows the "default" camera for this ImportOptionsKit. The "default" camera is set during a Stream Import. There can only be a single default camera in a Stream file.
- Parameters
-
out_camera | The "default" camera from the Stream file. |
- Returns
- true if a default camera was specified, false otherwise.
◆ ShowPortfolio()
bool HPS.Stream.ImportResultsKit.ShowPortfolio |
( |
out HPS.PortfolioKey |
out_portfolio | ) |
|
|
inline |
Shows the portfolio which was used for any definitions that had to be created during import. This was either the portfolio specified by the user in the ImportOptionsKit passed to Stream.File.Import, or the portfolio that was created for this purpose during import.
- Parameters
-
out_portfolio | Portfolio that was used for any definitions that had to be created during import. |
- Returns
- true if a portfolio was specified, false otherwise.
◆ ShowSegment()
bool HPS.Stream.ImportResultsKit.ShowSegment |
( |
out HPS.SegmentKey |
out_segment | ) |
|
|
inline |
Shows the root segment which the HSF data was imported into. This was either the root segment specified by the user in the ImportOptionsKit passed to Stream.File.Import, or the root segment that was created for this purpose during import.
- Parameters
-
out_segment | Segment the HSF data was imported into. |
- Returns
- true if a root segment was specified, false otherwise.
◆ UnsetAlternateCameras()
Removes the alternate named cameras that were present in the HSF file. This is really only used when generating an ImportResultsKit which is being returned to a user following an HSF import.
- Returns
- A reference to this ImportResultsKit.
◆ UnsetAlternateRoot()
Removes the segment which was used when the import file tried to access segments above the root segment. This is really only used when generating an ImportResultsKit which is being returned to a user following an HSF import.
- Returns
- A reference to this ImportResultsKit.
◆ UnsetDefaultCamera()
Removes the "default" camera from this ImportResultsKit. This is generally only used for ImportResultsKits that are generated from a Stream import.
- Returns
- A reference to this ImportResultsKit.
◆ UnsetEverything()
◆ UnsetPortfolio()
Removes the portfolio which was used for any definitions that had to be created during import. This is really only used when generating an ImportResultsKit which is being returned to a user following an HSF import.
- Returns
- A reference to this ImportResultsKit.
◆ UnsetSegment()
Removes the root segment which the HSF data was imported into. This is really only used when generating an ImportResultsKit which is being returned to a user following an HSF import.
- Returns
- A reference to this ImportResultsKit.
The documentation for this class was generated from the following file:
- internals/hps_core/source/cs/HPS.Stream.cs