Stream

class HPS.Stream : IDisposable

The Stream class contains objects and enumerations used for importing and exporting HSF files.

Public Functions

void Dispose ()

Stream (HPS.Stream in_that)

Public Static Functions

HPS.Stream.Toolkit CreateToolkit ()

Create a new Toolkit. !

Return:A new Toolkit.

class AttributeLockImportEvent : public HPS.Stream.ImportEvent

Public Functions

AttributeLockImportEvent ()

AttributeLockImportEvent (HPS.SegmentKey in_segment_key, HPS.AttributeLockKit in_attribute_lock_kit)

override void Dispose ()

new IntPtr GetClassID ()

Properties

HPS.AttributeLockKit attribute_lock_kit { get; set; }

HPS.SegmentKey segment_key { get; set; }

class BoundingImportEvent : public HPS.Stream.ImportEvent

Public Functions

BoundingImportEvent ()

BoundingImportEvent (HPS.SegmentKey in_segment_key, HPS.BoundingKit in_bounding_kit)

override void Dispose ()

new IntPtr GetClassID ()

Properties

HPS.BoundingKit bounding_kit { get; set; }

HPS.SegmentKey segment_key { get; set; }

class CameraImportEvent : public HPS.Stream.ImportEvent

Public Functions

CameraImportEvent ()

CameraImportEvent (HPS.SegmentKey in_segment_key, HPS.CameraKit in_camera_kit)

override void Dispose ()

new IntPtr GetClassID ()

Properties

HPS.CameraKit camera_kit { get; set; }

HPS.SegmentKey segment_key { get; set; }

class CellularVolumeImportEvent : public HPS.Stream.ImportEvent

Public Functions

CellularVolumeImportEvent ()

CellularVolumeImportEvent (HPS.SegmentKey in_segment_key, HPS.EXPERIMENTAL.CellularVolumeKit in_cv_kit)

override void Dispose ()

new IntPtr GetClassID ()

Properties

HPS.EXPERIMENTAL.CellularVolumeKit cv_kit { get; set; }

HPS.SegmentKey segment_key { get; set; }

class CircleImportEvent : public HPS.Stream.ImportEvent

Public Functions

CircleImportEvent ()

CircleImportEvent (HPS.SegmentKey in_segment_key, HPS.CircleKit in_circle_kit)

override void Dispose ()

new IntPtr GetClassID ()

Properties

HPS.CircleKit circle_kit { get; set; }

HPS.SegmentKey segment_key { get; set; }

class CircularArcImportEvent : public HPS.Stream.ImportEvent

Public Functions

CircularArcImportEvent ()

CircularArcImportEvent (HPS.SegmentKey in_segment_key, HPS.CircularArcKit in_circular_arc_kit)

override void Dispose ()

new IntPtr GetClassID ()

Properties

HPS.CircularArcKit circular_arc_kit { get; set; }

HPS.SegmentKey segment_key { get; set; }

class CircularWedgeImportEvent : public HPS.Stream.ImportEvent

Public Functions

CircularWedgeImportEvent ()

CircularWedgeImportEvent (HPS.SegmentKey in_segment_key, HPS.CircularWedgeKit in_circular_wedge_kit)

override void Dispose ()

new IntPtr GetClassID ()

Properties

HPS.CircularWedgeKit circular_wedge_kit { get; set; }

HPS.SegmentKey segment_key { get; set; }

class ColorInterpolationImportEvent : public HPS.Stream.ImportEvent

Public Functions

ColorInterpolationImportEvent ()

ColorInterpolationImportEvent (HPS.SegmentKey in_segment_key, HPS.ColorInterpolationKit in_color_interpolation_kit)

override void Dispose ()

new IntPtr GetClassID ()

Properties

HPS.ColorInterpolationKit color_interpolation_kit { get; set; }

HPS.SegmentKey segment_key { get; set; }

class CommentImportEvent : public HPS.Stream.ImportEvent

Public Functions

CommentImportEvent ()

CommentImportEvent (HPS.SegmentKey in_segment_key, string in_comment)

override void Dispose ()

new IntPtr GetClassID ()

Properties

string comment { get; set; }

HPS.SegmentKey segment_key { get; set; }

class ConditionImportEvent : public HPS.Stream.ImportEvent

Public Functions

ConditionImportEvent ()

ConditionImportEvent (HPS.SegmentKey in_segment_key)

override void Dispose ()

new IntPtr GetClassID ()

Properties

string[] conditions { get; set; }

HPS.SegmentKey segment_key { get; set; }

class ContourLineImportEvent : public HPS.Stream.ImportEvent

Public Functions

ContourLineImportEvent ()

ContourLineImportEvent (HPS.SegmentKey in_segment_key, HPS.ContourLineKit in_contour_line_kit)

override void Dispose ()

new IntPtr GetClassID ()

Properties

HPS.ContourLineKit contour_line_kit { get; set; }

HPS.SegmentKey segment_key { get; set; }

class CubeMapDefinitionImportEvent : public HPS.Stream.ImportEvent

Public Functions

CubeMapDefinitionImportEvent ()

CubeMapDefinitionImportEvent (HPS.PortfolioKey in_portfolio_key, string in_name, HPS.ImageDefinition in_negative_z, HPS.ImageDefinition in_positive_z, HPS.ImageDefinition in_negative_x, HPS.ImageDefinition in_positive_x, HPS.ImageDefinition in_negative_y, HPS.ImageDefinition in_positive_y, HPS.TextureOptionsKit in_texture_kit)

override void Dispose ()

new IntPtr GetClassID ()

Properties

string name { get; set; }

HPS.ImageDefinition negative_x { get; set; }

HPS.ImageDefinition negative_y { get; set; }

HPS.ImageDefinition negative_z { get; set; }

HPS.PortfolioKey portfolio_key { get; set; }

HPS.ImageDefinition positive_x { get; set; }

HPS.ImageDefinition positive_y { get; set; }

HPS.ImageDefinition positive_z { get; set; }

HPS.TextureOptionsKit texture_kit { get; set; }

class CullingImportEvent : public HPS.Stream.ImportEvent

Public Functions

CullingImportEvent ()

CullingImportEvent (HPS.SegmentKey in_segment_key, HPS.CullingKit in_culling_kit)

override void Dispose ()

new IntPtr GetClassID ()

Properties

HPS.CullingKit culling_kit { get; set; }

HPS.SegmentKey segment_key { get; set; }

class CurveAttributeImportEvent : public HPS.Stream.ImportEvent

Public Functions

CurveAttributeImportEvent ()

CurveAttributeImportEvent (HPS.SegmentKey in_segment_key, HPS.CurveAttributeKit in_curve_attribute_kit)

override void Dispose ()

new IntPtr GetClassID ()

Properties

HPS.CurveAttributeKit curve_attribute_kit { get; set; }

HPS.SegmentKey segment_key { get; set; }

class CuttingSectionAttributeImportEvent : public HPS.Stream.ImportEvent

Public Functions

CuttingSectionAttributeImportEvent ()

CuttingSectionAttributeImportEvent (HPS.SegmentKey in_segment_key, HPS.CuttingSectionAttributeKit in_cutting_section_attribute_kit)

override void Dispose ()

new IntPtr GetClassID ()

Properties

HPS.CuttingSectionAttributeKit cutting_section_attribute_kit { get; set; }

HPS.SegmentKey segment_key { get; set; }

class CuttingSectionImportEvent : public HPS.Stream.ImportEvent

Public Functions

CuttingSectionImportEvent ()

CuttingSectionImportEvent (HPS.SegmentKey in_segment_key, HPS.CuttingSectionKit in_cutting_section_kit)

override void Dispose ()

new IntPtr GetClassID ()

Properties

HPS.CuttingSectionKit cutting_section_kit { get; set; }

HPS.SegmentKey segment_key { get; set; }

class CylinderAttributeImportEvent : public HPS.Stream.ImportEvent

Public Functions

CylinderAttributeImportEvent ()

CylinderAttributeImportEvent (HPS.SegmentKey in_segment_key, HPS.CylinderAttributeKit in_cylinder_attribute_kit)

override void Dispose ()

new IntPtr GetClassID ()

Properties

HPS.CylinderAttributeKit cylinder_attribute_kit { get; set; }

HPS.SegmentKey segment_key { get; set; }

class CylinderImportEvent : public HPS.Stream.ImportEvent

Public Functions

CylinderImportEvent ()

CylinderImportEvent (HPS.SegmentKey in_segment_key, HPS.CylinderKit in_cylinder_kit)

override void Dispose ()

new IntPtr GetClassID ()

Properties

HPS.CylinderKit cylinder_kit { get; set; }

HPS.SegmentKey segment_key { get; set; }

class DistantLightImportEvent : public HPS.Stream.ImportEvent

Public Functions

override void Dispose ()

DistantLightImportEvent ()

DistantLightImportEvent (HPS.SegmentKey in_segment_key, HPS.DistantLightKit in_distantlight_kit)

new IntPtr GetClassID ()

Properties

HPS.DistantLightKit distant_light_kit { get; set; }

HPS.SegmentKey segment_key { get; set; }

class DistantLightPropertyImportEvent : public HPS.Stream.ImportEvent

Public Functions

override void Dispose ()

DistantLightPropertyImportEvent ()

DistantLightPropertyImportEvent (HPS.DistantLightKey in_distant_light_key, HPS.DistantLightKit in_distant_light_kit)

new IntPtr GetClassID ()

Properties

HPS.DistantLightKey distant_light_key { get; set; }

HPS.DistantLightKit distant_light_kit { get; set; }

class DrawingAttributeImportEvent : public HPS.Stream.ImportEvent

Public Functions

override void Dispose ()

DrawingAttributeImportEvent ()

DrawingAttributeImportEvent (HPS.SegmentKey in_segment_key, HPS.DrawingAttributeKit in_drawing_attribute_kit)

new IntPtr GetClassID ()

Properties

HPS.DrawingAttributeKit drawing_attribute_kit { get; set; }

HPS.SegmentKey segment_key { get; set; }

class EdgeAttributeImportEvent : public HPS.Stream.ImportEvent

Public Functions

override void Dispose ()

EdgeAttributeImportEvent ()

EdgeAttributeImportEvent (HPS.SegmentKey in_segment_key, HPS.EdgeAttributeKit in_edge_attribute_kit)

new IntPtr GetClassID ()

Properties

HPS.EdgeAttributeKit edge_attribute_kit { get; set; }

HPS.SegmentKey segment_key { get; set; }

class EllipseImportEvent : public HPS.Stream.ImportEvent

Public Functions

override void Dispose ()

EllipseImportEvent ()

EllipseImportEvent (HPS.SegmentKey in_segment_key, HPS.EllipseKit in_ellipse_kit)

new IntPtr GetClassID ()

Properties

HPS.EllipseKit ellipse_kit { get; set; }

HPS.SegmentKey segment_key { get; set; }

class EllipticalArcImportEvent : public HPS.Stream.ImportEvent

Public Functions

override void Dispose ()

EllipticalArcImportEvent ()

EllipticalArcImportEvent (HPS.SegmentKey in_segment_key, HPS.EllipticalArcKit in_elliptical_arc_kit)

new IntPtr GetClassID ()

Properties

HPS.EllipticalArcKit elliptical_arc_kit { get; set; }

HPS.SegmentKey segment_key { get; set; }

class ExportEvent : public IDisposable

The ExportEvent class is the base class for events signaled during Stream export.

Subclassed by HPS.Stream.GeometryExportEvent, HPS.Stream.SegmentExportEvent

Public Functions

void Dispose ()

delegate void DtorDelegate (IntPtr cPtr)

ExportEvent (HPS.Stream.ExportEvent in_that)

IntPtr GetClassID ()

Returns a unique identifier that is shared by all objects of the same class.

Properties

byte[] non_db_user_data { get; set; }

class ExportEventHandler : public IDisposable

The ExportEventHandler class is the base class for user-defined ExportEvent handlers.

Public Functions

void Dispose ()

delegate void DtorDelegate (IntPtr cPtr)

ExportEventHandler ()

ExportEventHandler (HPS.Stream.ExportEventHandler in_that)

void Handle (HPS.Stream.ExportEvent in_event)

The handler function for Stream ExportEvents. Override this function to process the ExportEvent to suit your needs. This function is called synchronously as data is exported by Stream; Stream export will be paused until this function returns.

Param in_event:A pointer to the ExportEvent data.

class ExportNotifier : public HPS.IONotifier

The ExportNotifier class is a smart-pointer that is associated with an asynchronous file export. It is used to interact with an ongoing export or get the results from a completed export.

Public Functions

void Assign (HPS.Stream.ExportNotifier in_that)

Associate this ExportNotifier with the same file export as the source ExportNotifier.

Param in_that:The source ExportNotifier for the assignment.

override void Dispose ()

ExportNotifier ()

The default constructor creates an ExportNotifier object which is not associated with any file export.

ExportNotifier (HPS.IONotifier in_that)

The conversion constructor creates a new derived ExportNotifier object from a base IONotifier object. The copy will only be successful if the source notifier is really an upcast of this notifier type. Otherwise the copy will fail and the resulting ExportNotifier will be invalid.

Param in_that:The source IONotifier to copy.

ExportNotifier (HPS.Stream.ExportNotifier in_that)

The copy constructor creates a new ExportNotifier object that is associated with the same file export as the source ExportNotifier.

Param in_that:The source ExportNotifier 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.

class ExportOptionsKit : public HPS.Kit

The HPS.Stream.ExportOptionsKit class contains settings controlling the export of HSF files. Calling HPS.Stream.ExportOptionsKit.GetDefault() will return an options kit with values found in this table.

Public Functions

override void Dispose ()

override bool Empty ()

Indicates whether this ExportOptionsKit has any values set on it.

Return:true if no values are set on this ExportOptionsKit, false otherwise.

bool Equals (HPS.Stream.ExportOptionsKit in_kit)

Check if the source ExportOptionsKit is equivalent to this ExportOptionsKit.

Param in_kit:The source ExportOptionsKit to compare to this ExportOptionsKit. Return:true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)

ExportOptionsKit ()

The default constructor creates an empty ExportOptionsKit object.

ExportOptionsKit (HPS.Stream.ExportOptionsKit in_kit)

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

Param in_kit:The source ExportOptionsKit to copy.

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

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

void Set (HPS.Stream.ExportOptionsKit in_kit)

Copies the source ExportOptionsKit into this ExportOptionsKit.

Param in_kit:The source ExportOptionsKit to copy.

HPS.Stream.ExportOptionsKit SetColorCompression (bool in_state)

Sets color compression state and maximum number of bits to use for each (r,g,b) color. Defaults to no compression.

See also

Default value

Param in_state:Whether color compression is enabled or not. Return:A reference to this ExportOptionsKit.

HPS.Stream.ExportOptionsKit SetColorCompression (bool in_state, uint in_bits_per_color)

Sets color compression state and maximum number of bits to use for each (r,g,b) color. Defaults to no compression.

See also

Default value

Param in_state:Whether color compression is enabled or not. Param in_bits_per_color:  Number of bits to use per color when performing color compression. Value must be in the range [0, 72]. Defaults to 24. Return:A reference to this ExportOptionsKit.

HPS.Stream.ExportOptionsKit SetConnectivityCompression (bool in_state)

Sets connectivity (face list) compression state. Defaults to no compression.

See also

Default value

Param in_state:Whether color index compression is enabled or not. Return:A reference to this ExportOptionsKit.

HPS.Stream.ExportOptionsKit SetDefaultCamera (HPS.CameraKit in_camera)

Sets the default camera used for the export process. If no camera is specified, no default camera will be used during export.

Param in_camera:  The camera to apply as default. Return:A reference to this ExportOptionsKit.

HPS.Stream.ExportOptionsKit SetEventHandler (HPS.Stream.ExportEventHandler in_handler, IntPtr in_type)

Sets the specified ExportEventHandler for the indicated ExportEvent type.

Param in_handler:  An ExportEventHandler to be set. Param in_type:The type of the StreamExportEvent for which the given event handler will be used. Return:A reference to this ExportOptionsKit.

HPS.Stream.ExportOptionsKit SetImageCompression (bool in_state)

Sets image compression state for uncompressed images in segment tree. Defaults to no compression, though the images will be converted to lossless PNG data within the file.

See also

Default value

Param in_state:Whether to compress uncompressed images. If false, uncompressed images will be exported as lossless PNG, if true, they are exported as JPEG with the specified quality. Return:A reference to this ExportOptionsKit.

HPS.Stream.ExportOptionsKit SetImageCompression (bool in_state, float in_quality)

Sets image compression state for uncompressed images in segment tree. Defaults to no compression, though the images will be converted to lossless PNG data within the file.

See also

Default value

Param in_state:Whether to compress uncompressed images. If false, uncompressed images will be exported as lossless PNG, if true, they are exported as JPEG with the specified quality. Param in_quality:  Float in the range [0,1] indicating the quality of the JPEG image. Defaults to 0.75f. Return:A reference to this ExportOptionsKit.

HPS.Stream.ExportOptionsKit SetIndexCompression (bool in_state)

Sets color index compression state and maximum number of bits to use for each float index. Defaults to no compression.

See also

Default value

Param in_state:Whether color index compression is enabled or not. Return:A reference to this ExportOptionsKit.

HPS.Stream.ExportOptionsKit SetIndexCompression (bool in_state, uint in_bits_per_index)

Sets color index compression state and maximum number of bits to use for each float index. Defaults to no compression.

See also

Default value

Param in_state:Whether color index compression is enabled or not. Param in_bits_per_index:  Number of bits to use per index when performing color index compression. Value must be in the range [0, 24]. Defaults to 8. Return:A reference to this ExportOptionsKit.

HPS.Stream.ExportOptionsKit SetNormalCompression (bool in_state)

Sets normal compression state and maximum number of bits to use for each (x,y,z) normal. Defaults to no compression.

See also

Default value

Param in_state:Whether normal compression is enabled or not. Return:A reference to this ExportOptionsKit.

HPS.Stream.ExportOptionsKit SetNormalCompression (bool in_state, uint in_bits_per_normal)

Sets normal compression state and maximum number of bits to use for each (x,y,z) normal. Defaults to no compression.

See also

Default value

Param in_state:Whether normal compression is enabled or not. Param in_bits_per_normal:  Number of bits to use per normal when performing normal compression. Value must be in the range [0, 72]. Defaults to 10. Return:A reference to this ExportOptionsKit.

HPS.Stream.ExportOptionsKit SetParameterCompression (bool in_state)

Sets vertex parameter compression state and maximum number of bits to use for each (single) vertex parameter. Defaults to no compression.

Param in_state:Whether parameter compression is enabled or not. Return:A reference to this ExportOptionsKit.

HPS.Stream.ExportOptionsKit SetParameterCompression (bool in_state, uint in_bits_per_parameter)

Sets vertex parameter compression state and maximum number of bits to use for each (single) vertex parameter. Defaults to no compression.

Param in_state:Whether parameter compression is enabled or not. Param in_bits_per_parameter:  Number of bits to use per parameter when performing parameter compression. Value must be in the range [0, 24]. Defaults to 8. Return:A reference to this ExportOptionsKit.

HPS.Stream.ExportOptionsKit SetSerializeTristrips (bool in_state)

Sets tristrips serialization state. Defaults to tristrips are serialized.

See also

Default value

Param in_state:Whether tristrips serialization is enabled or not. Return:A reference to this ExportOptionsKit.

HPS.Stream.ExportOptionsKit SetToolkit (HPS.Stream.Toolkit in_toolkit)

Sets the toolkit used for the export process. If no toolkit is specified, a default tookit will be used during export.

Return:A reference to this ExportOptionsKit.

HPS.Stream.ExportOptionsKit SetVertexCompression (bool in_state)

Sets vertex compression state and maximum number of bits to use for each (x,y,z) vertex. Defaults to no compression.

See also

Default value

Param in_state:Whether vertex compression is enabled or not. Return:A reference to this ExportOptionsKit.

HPS.Stream.ExportOptionsKit SetVertexCompression (bool in_state, uint in_bits_per_vertex)

Sets vertex compression state and maximum number of bits to use for each (x,y,z) vertex. Defaults to no compression.

See also

Default value

Param in_state:Whether vertex compression is enabled or not. Param in_bits_per_vertex:  Number of bits to use per vertex when performing vertex compression. Value must be in the range [0, 72]. Defaults to 24. Return:A reference to this ExportOptionsKit.

void Show (out HPS.Stream.ExportOptionsKit out_kit)

Copies this ExportOptionsKit into the given ExportOptionsKit.

Param out_kit:The ExportOptionsKit to populate with the contents of this ExportOptionsKit.

bool ShowColorCompression (out bool out_state, out uint out_bits_per_color)

Shows color compression state and maximum number of bits to use for each (r,g,b) color.

Param out_state:  Whether color compression is enabled or not. Param out_bits_per_color:  Number of bits to use per color when performing color compression. Return:true if a color compression setting was specified, false otherwise.

bool ShowConnectivityCompression (out bool out_state)

Shows connectivity (face list) compression state.

Param out_state:  Whether connectivity compression is enabled or not. Return:true if a connectivity compression setting was specified, false otherwise.

bool ShowDefaultCamera (out HPS.CameraKit out_camera)

Shows the default camera used for the export process.

Param out_camera:  The camera being used as default. Return:A reference to this ExportOptionsKit.

bool ShowImageCompression (out bool out_state, out float out_quality)

Shows image compression state for uncompressed images in segment tree.

Param out_state:  Whether image compression is enabled or not. Param out_quality:  Float in the range [0,1] indicating the quality of the JPEG image. Return:true if an image compression setting was specified, false otherwise.

bool ShowIndexCompression (out bool out_state, out uint out_bits_per_index)

Shows color index compression state and maximum number of bits to use for each float index.

Param out_state:  Whether color index compression is enabled or not. Param out_bits_per_index:  Number of bits to use per index when performing color index compression. Return:true if a color index compression setting was specified, false otherwise.

bool ShowNormalCompression (out bool out_state, out uint out_bits_per_normal)

Shows normal compression state and maximum number of bits to use for each (x,y,z) normal.

Param out_state:  Whether normal compression is enabled or not. Param out_bits_per_normal:  Number of bits to use per normal when performing normal compression. Return:true if a normal compression setting was specified, false otherwise.

bool ShowParameterCompression (out bool out_state, out uint out_bits_per_parameter)

Shows vertex parameter compression state and maximum number of bits to use for each (single) vertex parameter.

Param out_state:  Whether parameter compression is enabled or not. Param out_bits_per_parameter:  Number of bits to use per parameter when performing parameter compression. Return:true if a parameter compression setting was specified, false otherwise.

bool ShowSerializeTristrips (out bool out_state)

Shows tristrips serialization state.

Param out_state:  Whether tristrips serialization is enabled or not. Return:true if a tristrips serialization setting was specified, false otherwise.

bool ShowToolkit (out HPS.Stream.Toolkit out_toolkit)

Shows the root toolkit used for the export process.

Param out_toolkit:  The Toolkit used for the export process. Return:true if a toolkit was specified, false otherwise.

bool ShowVertexCompression (out bool out_state, out uint out_bits_per_vertex)

Shows vertex compression state and maximum number of bits to use for each (x,y,z) vertex.

Param out_state:  Whether vertex compression is enabled or not. Param out_bits_per_vertex:  Number of bits to use per vertex when performing vertex compression. Return:true if a vertex compression setting was specified, false otherwise.

HPS.Stream.ExportOptionsKit UnsetColorCompression ()

Removes color compression state and maximum number of bits to use for each (r,g,b) color.

Return:A reference to this ExportOptionsKit.

HPS.Stream.ExportOptionsKit UnsetConnectivityCompression ()

Removes connectivity (face list) compression state.

Return:A reference to this ExportOptionsKit.

HPS.Stream.ExportOptionsKit UnsetDefaultCamera ()

Removes the default camera used for the export process.

Return:A reference to this ExportOptionsKit.

HPS.Stream.ExportOptionsKit UnsetEventHandler (IntPtr in_type)

Unsets the ExportEventHandler for the indicated ExportEvent type.

Param in_type:The type of the StreamExportEvent to unset. Return:A reference to this ExportOptionsKit.

HPS.Stream.ExportOptionsKit UnsetEventHandlers ()

Unsets the ExportEventHandler for all ExportEvent types.

Return:A reference to this ExportOptionsKit.

HPS.Stream.ExportOptionsKit UnsetEverything ()

Removes all settings from this ExportOptionsKit.

Return:A reference to this ExportOptionsKit.

HPS.Stream.ExportOptionsKit UnsetImageCompression ()

Removes image compression state for uncompressed images in segment tree.

Return:A reference to this ExportOptionsKit.

HPS.Stream.ExportOptionsKit UnsetIndexCompression ()

Removes color index compression state and maximum number of bits to use for each float index.

Return:A reference to this ExportOptionsKit.

HPS.Stream.ExportOptionsKit UnsetNormalCompression ()

Removes normal compression state and maximum number of bits to use for each (x,y,z) normal.

Return:A reference to this ExportOptionsKit.

HPS.Stream.ExportOptionsKit UnsetParameterCompression ()

Removes vertex parameter compression state and maximum number of bits to use for each (single) vertex parameter.

Return:A reference to this ExportOptionsKit.

HPS.Stream.ExportOptionsKit UnsetSerializeTristrips ()

Removes tristrips serialization state.

Return:A reference to this ExportOptionsKit.

HPS.Stream.ExportOptionsKit UnsetToolkit ()

Removes the toolkit used for the export process.

Return:A reference to this ExportOptionsKit.

HPS.Stream.ExportOptionsKit UnsetVertexCompression ()

Removes vertex compression state and maximum number of bits to use for each (x,y,z) vertex.

Return:A reference to this ExportOptionsKit.

Public Static Functions

HPS.Stream.ExportOptionsKit GetDefault ()

Creates a 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.

Return:A ExportOptionsKit with the default settings.

bool operator!= (HPS.Stream.ExportOptionsKit a, HPS.Stream.ExportOptionsKit b)

bool operator== (HPS.Stream.ExportOptionsKit a, HPS.Stream.ExportOptionsKit b)

class ExportStartedEvent : public HPS.Event

The ExportStartedEvent class indicates that a Stream export has started. It will always be injected synchronously.

Public Functions

override string ClassName ()

override HPS.Event Clone ()

Allocates and returns a copy of this ExportStartedEvent.

Return:A copy of this TimerEvent.

override void Dispose ()

override bool Drop (HPS.Event in_that_event)

Determines if this ExportStartedEvent can be drop in favor of the following event of the same type

Param in_that_event:  Event to compare with this ExportStartedEvent. Return:true if this event can be dropped, false otherwise.

ExportStartedEvent ()

The default constructor creates a ExportStartedEvent object.

ExportStartedEvent (HPS.Event in_event)

This constructor converts an EventObject to a ExportStartedEvent object.

Param in_event:The EventObject to be converted.

ExportStartedEvent (HPS.Stream.ExportStartedEvent in_that)

override IntPtr Freshen ()

This optional function is used to determine if the current event can be dropped in favor of newer event of the same type if one is available.

Return:A cookie representing the freshen category. Zero indicates a non-freshening event.

Properties

double export_started_time { get; set; }

class File : public IDisposable

The File class provides functions to import and export HSF files.

Public Functions

void Dispose ()

File (HPS.Stream.File in_that)

Public Static Functions

HPS.Stream.ExportNotifier Export (HPS.SegmentKey in_segment, HPS.Stream.ExportOptionsKit in_options, out byte[][] out_hsf_buffers)

Performs an asynchronous HSF export of the given segment with the provided options to a list of output buffers. An exception will be thrown if a problem is encountered during export.

Param in_segment:  Segment containing the data to export. Param in_options:  Options controlling the export of the HSF data. Param out_hsf_buffers:  The output buffers the exported HSF data is written to. Return:An ExportNotifier object that can be used to query the export progress and status.

HPS.Stream.ExportNotifier Export (string in_file_name, HPS.SegmentKey in_segment, HPS.Stream.ExportOptionsKit in_options)

Performs an asynchronous HSF export of the given segment with the provided options to a given filename. An exception will be thrown if a problem is encountered during export.

Param in_file_name:  Name of the file to write the HSF data to. Param in_segment:  Segment containing the data to export. Param in_options:  Options controlling the export of the HSF data. Return:An ExportNotifier object that can be used to query the export progress and status.

HPS.Stream.ImportNotifier Import (byte[][] in_hsf_buffers, HPS.Stream.ImportOptionsKit in_options)

Performs an asynchronous import of the specified HSF file with the provided options. May throw an IOException prior to starting the asynchronous import.

Deprecated:

This function has been deprecated, please use Import with an ImportNotifier as parameter.

Param in_hsf_buffers:  The buffer of HSF data to import. Param in_options:  Options controlling the import of the HSF file (e.g., segment to import into). Return:An ImportNotfier object that can be used to query the import progress and status.

void Import (byte[][] in_hsf_buffers, HPS.Stream.ImportOptionsKit in_options, HPS.Stream.ImportNotifier in_notifier)

Performs an asynchronous import of the specified HSF file with the provided options. May throw an IOException prior to starting the asynchronous import.

Param in_hsf_buffers:  The buffer of HSF data to import. Param in_options:  ImportNotfier object that can be used to query the import progress and status. Param in_notifier:  The notifier to be used during the import

HPS.Stream.ImportNotifier Import (string in_file_name, HPS.Stream.ImportOptionsKit in_options)

Performs an asynchronous import of the specified HSF file with the provided options. May throw an IOException prior to starting the asynchronous import.

Deprecated:

This function has been deprecated, please use Import with an ImportNotifier as parameter.

Param in_file_name:  Name of HSF file to import. Param in_options:  Options controlling the import of the HSF file (e.g., segment to import into). Return:An ImportNotfier object that can be used to query the import progress and status.

void Import (string in_file_name, HPS.Stream.ImportOptionsKit in_options, HPS.Stream.ImportNotifier in_notifier)

Performs an asynchronous import of the specified HSF file with the provided options. May throw an IOException prior to starting the asynchronous import.

Param in_file_name:  Name of HSF file to import. Param in_options:  ImportNotfier object that can be used to query the import progress and status. Param in_notifier:  The notifier to be used during the import

class GeometryExportEvent : public HPS.Stream.ExportEvent

The GeometryExportEvent class indicates that geometry is about to be exported by Stream.

Public Functions

override void Dispose ()

GeometryExportEvent ()

GeometryExportEvent (HPS.Key in_key)

new IntPtr GetClassID ()

Properties

HPS.Key key { get; set; }

class GlyphDefinitionImportEvent : public HPS.Stream.ImportEvent

Public Functions

override void Dispose ()

new IntPtr GetClassID ()

GlyphDefinitionImportEvent ()

GlyphDefinitionImportEvent (HPS.PortfolioKey in_portfolio_key, string in_name, HPS.GlyphKit in_glyph_kit)

Properties

HPS.GlyphKit glyph_kit { get; set; }

string name { get; set; }

HPS.PortfolioKey portfolio_key { get; set; }

class GridImportEvent : public HPS.Stream.ImportEvent

Public Functions

override void Dispose ()

new IntPtr GetClassID ()

GridImportEvent ()

GridImportEvent (HPS.SegmentKey in_segment_key, HPS.GridKit in_grid_kit)

Properties

HPS.GridKit grid_kit { get; set; }

HPS.SegmentKey segment_key { get; set; }

class HiddenLineAttributeImportEvent : public HPS.Stream.ImportEvent

Public Functions

override void Dispose ()

new IntPtr GetClassID ()

HiddenLineAttributeImportEvent ()

HiddenLineAttributeImportEvent (HPS.SegmentKey in_segment_key, HPS.HiddenLineAttributeKit in_hidden_attribute_kit)

Properties

HPS.HiddenLineAttributeKit hidden_line_attribute_kit { get; set; }

HPS.SegmentKey segment_key { get; set; }

class ImageDefinitionImportEvent : public HPS.Stream.ImportEvent

Public Functions

override void Dispose ()

new IntPtr GetClassID ()

ImageDefinitionImportEvent ()

ImageDefinitionImportEvent (HPS.PortfolioKey in_portfolio_key, string in_name, HPS.ImageKit in_image_kit)

Properties

HPS.ImageKit image_kit { get; set; }

string name { get; set; }

HPS.PortfolioKey portfolio_key { get; set; }

class ImportCompletedEvent : public HPS.Event

The ImportCompletedEvent class indicates that a Stream import is complete. It will always be injected synchronously.

Public Functions

override string ClassName ()

override HPS.Event Clone ()

Allocates and returns a copy of this ImportCompletedEvent.

Return:A copy of this TimerEvent.

override void Dispose ()

override bool Drop (HPS.Event in_that_event)

Determines if this ImportCompletedEvent can be drop in favor of the following event of the same type

Param in_that_event:  Event to compare with this ImportCompletedEvent. Return:true if this event can be dropped, false otherwise.

override IntPtr Freshen ()

This optional function is used to determine if the current event can be dropped in favor of newer event of the same type if one is available.

Return:A cookie representing the freshen category. Zero indicates a non-freshening event.

ImportCompletedEvent ()

The default constructor creates a ImportCompletedEvent object.

ImportCompletedEvent (HPS.Event in_event)

This constructor converts an EventObject to a ImportCompletedEvent object.

Param in_event:The EventObject to be converted.

ImportCompletedEvent (HPS.Stream.ImportCompletedEvent in_that)

Properties

double import_completed_time { get; set; }

class ImportEvent : public IDisposable

The ImportEvent class is the base class for events signaled during Stream export.

Subclassed by HPS.Stream.AttributeLockImportEvent, HPS.Stream.BoundingImportEvent, HPS.Stream.CameraImportEvent, HPS.Stream.CellularVolumeImportEvent, HPS.Stream.CircleImportEvent, HPS.Stream.CircularArcImportEvent, HPS.Stream.CircularWedgeImportEvent, HPS.Stream.ColorInterpolationImportEvent, HPS.Stream.CommentImportEvent, HPS.Stream.ConditionImportEvent, HPS.Stream.ContourLineImportEvent, HPS.Stream.CubeMapDefinitionImportEvent, HPS.Stream.CullingImportEvent, HPS.Stream.CurveAttributeImportEvent, HPS.Stream.CuttingSectionAttributeImportEvent, HPS.Stream.CuttingSectionImportEvent, HPS.Stream.CylinderAttributeImportEvent, HPS.Stream.CylinderImportEvent, HPS.Stream.DistantLightImportEvent, HPS.Stream.DistantLightPropertyImportEvent, HPS.Stream.DrawingAttributeImportEvent, HPS.Stream.EdgeAttributeImportEvent, HPS.Stream.EllipseImportEvent, HPS.Stream.EllipticalArcImportEvent, HPS.Stream.GlyphDefinitionImportEvent, HPS.Stream.GridImportEvent, HPS.Stream.HiddenLineAttributeImportEvent, HPS.Stream.ImageDefinitionImportEvent, HPS.Stream.IncludeSegmentImportEvent, HPS.Stream.InfiniteLineImportEvent, HPS.Stream.LegacyShaderDefinitionImportEvent, HPS.Stream.LightingAttributeImportEvent, HPS.Stream.LineAttributeImportEvent, HPS.Stream.LineImportEvent, HPS.Stream.LinePatternDefinitionImportEvent, HPS.Stream.MarkerAttributeImportEvent, HPS.Stream.MarkerImportEvent, HPS.Stream.MaterialImportEvent, HPS.Stream.MaterialPaletteDefinitionImportEvent, HPS.Stream.MaterialPaletteImportEvent, HPS.Stream.MatrixImportEvent, HPS.Stream.MeshImportEvent, HPS.Stream.MeshInstanceImportEvent, HPS.Stream.NURBSCurveImportEvent, HPS.Stream.NURBSSurfaceAttributeImportEvent, HPS.Stream.NURBSSurfaceImportEvent, HPS.Stream.NamedStyleDefinitionImportEvent, HPS.Stream.NamedStyleImportEvent, HPS.Stream.NonDBUserDataImportEvent, HPS.Stream.PerformanceImportEvent, HPS.Stream.PolygonImportEvent, HPS.Stream.PriorityImportEvent, HPS.Stream.ReferenceGeometryImportEvent, HPS.Stream.SegmentImportEvent, HPS.Stream.SelectabilityImportEvent, HPS.Stream.ShapeDefinitionImportEvent, HPS.Stream.ShellImportEvent, HPS.Stream.ShellInstanceImportEvent, HPS.Stream.SphereAttributeImportEvent, HPS.Stream.SphereImportEvent, HPS.Stream.SpotlightImportEvent, HPS.Stream.StyleSegmentImportEvent, HPS.Stream.SubwindowImportEvent, HPS.Stream.TextAttributeImportEvent, HPS.Stream.TextImportEvent, HPS.Stream.TextureDefinitionImportEvent, HPS.Stream.TransformMaskImportEvent, HPS.Stream.TransparencyImportEvent, HPS.Stream.UserDataImportEvent, HPS.Stream.VisibilityImportEvent, HPS.Stream.VisualEffectsImportEvent

Public Functions

void Dispose ()

delegate void DtorDelegate (IntPtr cPtr)

IntPtr GetClassID ()

Returns a unique identifier that is shared by all objects of the same class.

ImportEvent (HPS.Stream.ImportEvent in_that)

class ImportEventHandler : public IDisposable

The ImportEventHandler class is the base class for user-defined ImportEvent handlers. If your ImportEventHandler elects not to import incoming geometry, then subsequent operations on that geometry along with follow-up attributes (priority, user-data, etc…) will throw an InvalidObjectException.

Public Functions

void Dispose ()

delegate void DtorDelegate (IntPtr cPtr)

bool Handle (HPS.Stream.ImportEvent in_event)

The handler function for Stream ImportEvents. Override this function to process the ImportEvent to suit your needs. This function is called synchronously as data is imported by Stream; Stream import will be paused until this function returns.

Param in_event:A pointer to the ImportEvent representing the impending change to the database. Return:A bool that specifies if the database change indicated by in_event should be applied. true means that the change will be applied to the database; false means that no change will be made.

ImportEventHandler ()

ImportEventHandler (HPS.Stream.ImportEventHandler in_that)

class ImportNotifier : public HPS.IONotifier

The ImportNotifier class is a smart-pointer that is associated with an asynchronous file import. It is used to interact with an ongoing import or get the results from a completed import.

Public Functions

void Assign (HPS.Stream.ImportNotifier in_that)

Associate this ImportNotifier with the same file import as the source ImportNotifier.

Param in_that:The source ImportNotifier for the assignment.

override void Dispose ()

HPS.Stream.ImportResultsKit GetResults ()

Get the ImportResultsKit for the file import. Throws an IOException if the import is not complete or was not successful.

Return:The ImportResultsKit for a successful file import.

ImportNotifier ()

The default constructor creates an ImportNotifier object which is not associated with any file import.

ImportNotifier (HPS.IONotifier in_that)

The conversion constructor creates a new derived ImportNotifier object from a base IONotifier object. The copy will only be successful if the source notifier is really an upcast of this notifier type. Otherwise the copy will fail and the resulting ImportNotifier will be invalid.

Param in_that:The source IONotifier to copy.

ImportNotifier (HPS.Stream.ImportNotifier in_that)

The copy constructor creates a new ImportNotifier object that is associated with the same file import as the source ImportNotifier.

Param in_that:The source ImportNotifier 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.

class ImportOptionsKit : public HPS.Kit

The ImportOptionsKit class contains any settings controlling the import of HSF files.

Public Functions

override void Dispose ()

override bool Empty ()

Indicates whether this ImportOptionsKit has any values set on it.

Return:true if no values are set on this ImportOptionsKit, false otherwise.

bool Equals (HPS.Stream.ImportOptionsKit in_kit)

Check if the source ImportOptionsKit is equivalent to this ImportOptionsKit.

Param in_kit:The source ImportOptionsKit to compare to this ImportOptionsKit. Return:true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)

override int GetHashCode ()

ImportOptionsKit ()

The default constructor creates an empty ImportOptionsKit object.

ImportOptionsKit (HPS.Stream.ImportOptionsKit in_kit)

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

Param in_kit:The source ImportOptionsKit 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.Stream.ImportOptionsKit in_kit)

Copies the source ImportOptionsKit into this ImportOptionsKit.

Param in_kit:The source ImportOptionsKit to copy.

HPS.Stream.ImportOptionsKit SetAlternateRoot (HPS.SegmentKey in_segment)

Sets the segment which will be used when the import file tries to access segments above the root segment. If no segment is specified, a root segment will be created for this purpose during import.

Param in_segment:  Segment that will be used when the import file tries to access segments above the root segment. Return:A reference to this ImportOptionsKit.

HPS.Stream.ImportOptionsKit SetEventHandler (HPS.Stream.ImportEventHandler in_handler, IntPtr in_type)

Sets the specified ImportEventHandler for the indicated ImportEvent type.

Param in_handler:  An ImportEventHandler to be set. Param in_type:The type of the StreamImportEvent for which the given event handler will be used. Return:A reference to this ImportOptionsKit.

HPS.Stream.ImportOptionsKit SetPortfolio (HPS.PortfolioKey in_portfolio)

Sets the portfolio which will be used for any definitions that need to be created during import. If no portfolio is specified, a portfolio will be created for this purpose during import.

Param in_portfolio:  Portfolio that will be used for any definitions that need to be created during import. Return:A reference to this ImportOptionsKit.

HPS.Stream.ImportOptionsKit SetSegment (HPS.SegmentKey in_segment)

Sets the root segment where the HSF data will be imported into. If no segment is specified, a root segment will be created for this purpose during import.

Param in_segment:  Segment the HSF data will be imported into. Return:A reference to this ImportOptionsKit.

HPS.Stream.ImportOptionsKit SetToolkit (HPS.Stream.Toolkit in_toolkit)

Sets the toolkit used for the import process. If no tooklkit is specified, a default tookit will be used during import.

Return:A reference to this ImportOptionsKit.

void Show (out HPS.Stream.ImportOptionsKit out_kit)

Copies this ImportOptionsKit into the given ImportOptionsKit.

Param out_kit:The ImportOptionsKit to populate with the contents of this ImportOptionsKit.

bool ShowAlternateRoot (out HPS.SegmentKey out_segment)

Shows the segment which will be used when the import file tries to access segments above the root segment.

Param out_segment:  Segment that will be used when the import file tries to access segments above the root segment. Return:true if an alternate root segment was specified, false otherwise.

bool ShowPortfolio (out HPS.PortfolioKey out_portfolio)

Shows the portfolio which will be used for any definitions that need to be created during import.

Param out_portfolio:  Portfolio that will be used for any definitions that need to be created during import. Return:true if a portfolio was specified, false otherwise.

bool ShowSegment (out HPS.SegmentKey out_segment)

Shows the root segment where the HSF data will be imported into.

Param out_segment:  Segment the HSF data will be imported into. Return:true if a root segment was specified, false otherwise.

bool ShowToolkit (out HPS.Stream.Toolkit out_toolkit)

Shows the root toolkit used for the import process.

Param out_toolkit:  The Toolkit used for the import process. Return:true if a toolkit was specified, false otherwise.

HPS.Stream.ImportOptionsKit UnsetAlternateRoot ()

Removes the segment which will be used when the import file tries to access segments above the root segment.

Return:A reference to this ImportOptionsKit.

HPS.Stream.ImportOptionsKit UnsetEventHandler (IntPtr in_type)

Unsets the ImportEventHandler for the indicated ImportEvent type.

Param in_type:The type of the StreamImportEvent to unset. Return:A reference to this ImportOptionsKit.

HPS.Stream.ImportOptionsKit UnsetEventHandlers ()

Unsets the ImportEventHandler for all ImportEvent types.

Return:A reference to this ImportOptionsKit.

HPS.Stream.ImportOptionsKit UnsetEverything ()

Removes all settings from this ImportOptionsKit.

Return:A reference to this ImportOptionsKit.

HPS.Stream.ImportOptionsKit UnsetPortfolio ()

Removes the portfolio which will be used for any definitions that need to be created during import.

Return:A reference to this ImportOptionsKit.

HPS.Stream.ImportOptionsKit UnsetSegment ()

Removes the root segment speciyfing where the HSF data will be imported into.

Return:A reference to this ImportOptionsKit.

HPS.Stream.ImportOptionsKit UnsetToolkit ()

Removes the toolkit used for the import process.

Return:A reference to this ImportOptionsKit.

Public Static Functions

bool operator!= (HPS.Stream.ImportOptionsKit a, HPS.Stream.ImportOptionsKit b)

bool operator== (HPS.Stream.ImportOptionsKit a, HPS.Stream.ImportOptionsKit b)

class ImportResultsKit : public HPS.Kit

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

Public Functions

override void Dispose ()

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

override bool Equals (Object obj)

override int GetHashCode ()

ImportResultsKit ()

The default constructor creates an empty ImportResultsKit object.

ImportResultsKit (HPS.Stream.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.Stream.ImportResultsKit in_kit)

Copies the source ImportResultsKit into this ImportResultsKit.

Param in_kit:The source ImportResultsKit to copy.

HPS.Stream.ImportResultsKit SetAlternateCameras (string[] in_names, HPS.CameraKit[] in_cameras)

HPS.Stream.ImportResultsKit SetAlternateRoot (HPS.SegmentKey in_segment)

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.

Param in_segment:  Segment that was used when the import file tried to access segments above the root segment during import. Return:A reference to this ImportResultsKit.

HPS.Stream.ImportResultsKit SetDefaultCamera (HPS.CameraKit in_camera)

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.

Param in_camera:  The “default” named camera from the HSF file. Return:A reference to this ImportResultsKit.

HPS.Stream.ImportResultsKit SetPortfolio (HPS.PortfolioKey in_portfolio)

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.

Param in_portfolio:  Portfolio that was used for any definitions that had to be created during import. Return:A reference to this ImportResultsKit.

HPS.Stream.ImportResultsKit SetSegment (HPS.SegmentKey in_segment)

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.

Param in_segment:  Segment the HSF data was imported into. Return:A reference to this ImportResultsKit.

void Show (out HPS.Stream.ImportResultsKit out_kit)

Copies this ImportResultsKit into the given ImportResultsKit.

Param out_kit:The ImportResultsKit to populate with the contents of this ImportResultsKit.

bool ShowAlternateCameras (out string[] out_names, out HPS.CameraKit[] out_cameras)

bool ShowAlternateRoot (out HPS.SegmentKey out_segment)

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.

Param out_segment:  Segment that was used when the import file tried to access segments above the root segment. Return:true if an alternate root segment was specified, false otherwise.

bool ShowDefaultCamera (out HPS.CameraKit out_camera)

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.

Param out_camera:  The “default” camera from the Stream file. Return:true if a default camera was specified, false otherwise.

bool ShowPortfolio (out HPS.PortfolioKey out_portfolio)

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.

Param out_portfolio:  Portfolio that was used for any definitions that had to be created during import. Return:true if a portfolio was specified, false otherwise.

bool ShowSegment (out HPS.SegmentKey out_segment)

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.

Param out_segment:  Segment the HSF data was imported into. Return:true if a root segment was specified, false otherwise.

HPS.Stream.ImportResultsKit 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.

Return:A reference to this ImportResultsKit.

HPS.Stream.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.

Return:A reference to this ImportResultsKit.

HPS.Stream.ImportResultsKit UnsetDefaultCamera ()

Removes the “default” camera from this ImportResultsKit. This is generally only used for ImportResultsKits that are generated from a Stream import.

Return:A reference to this ImportResultsKit.

HPS.Stream.ImportResultsKit UnsetEverything ()

Removes all settings from this ImportResultsKit.

Return:A reference to this ImportResultsKit.

HPS.Stream.ImportResultsKit 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.

Return:A reference to this ImportResultsKit.

HPS.Stream.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.

Return:A reference to this ImportResultsKit.

Public Static Functions

bool operator!= (HPS.Stream.ImportResultsKit a, HPS.Stream.ImportResultsKit b)

bool operator== (HPS.Stream.ImportResultsKit a, HPS.Stream.ImportResultsKit b)

class IncludeSegmentImportEvent : public HPS.Stream.ImportEvent

Public Functions

override void Dispose ()

new IntPtr GetClassID ()

IncludeSegmentImportEvent ()

Properties

HPS.ConditionalExpression condition { get; set; }

HPS.AttributeLock.Type[] filter_types { get; set; }

HPS.SegmentKey reference_segment_key { get; set; }

HPS.SegmentKey segment_key { get; set; }

class InfiniteLineImportEvent : public HPS.Stream.ImportEvent

Public Functions

override void Dispose ()

new IntPtr GetClassID ()

InfiniteLineImportEvent ()

InfiniteLineImportEvent (HPS.SegmentKey in_segment_key, HPS.InfiniteLineKit in_infinite_line_kit)

Properties

HPS.InfiniteLineKit infinite_line_kit { get; set; }

HPS.SegmentKey segment_key { get; set; }

class LightingAttributeImportEvent : public HPS.Stream.ImportEvent

Public Functions

override void Dispose ()

new IntPtr GetClassID ()

LightingAttributeImportEvent ()

LightingAttributeImportEvent (HPS.SegmentKey in_segment_key, HPS.LightingAttributeKit in_lighting_attribute_kit)

Properties

HPS.LightingAttributeKit lighting_attribute_kit { get; set; }

HPS.SegmentKey segment_key { get; set; }

class LineAttributeImportEvent : public HPS.Stream.ImportEvent

Public Functions

override void Dispose ()

new IntPtr GetClassID ()

LineAttributeImportEvent ()

LineAttributeImportEvent (HPS.SegmentKey in_segment_key, HPS.LineAttributeKit in_line_attribute_kit)

Properties

HPS.LineAttributeKit line_attribute_kit { get; set; }

HPS.SegmentKey segment_key { get; set; }

class LineImportEvent : public HPS.Stream.ImportEvent

Public Functions

override void Dispose ()

new IntPtr GetClassID ()

LineImportEvent ()

LineImportEvent (HPS.SegmentKey in_segment_key, HPS.LineKit in_line_kit)

Properties

HPS.LineKit line_kit { get; set; }

HPS.SegmentKey segment_key { get; set; }

class LinePatternDefinitionImportEvent : public HPS.Stream.ImportEvent

Public Functions

override void Dispose ()

new IntPtr GetClassID ()

LinePatternDefinitionImportEvent ()

LinePatternDefinitionImportEvent (HPS.PortfolioKey in_portfolio_key, string in_name, HPS.LinePatternKit in_line_pattern_kit)

Properties

HPS.LinePatternKit line_pattern_kit { get; set; }

string name { get; set; }

HPS.PortfolioKey portfolio_key { get; set; }

class MarkerAttributeImportEvent : public HPS.Stream.ImportEvent

Public Functions

override void Dispose ()

new IntPtr GetClassID ()

MarkerAttributeImportEvent ()

MarkerAttributeImportEvent (HPS.SegmentKey in_segment_key, HPS.MarkerAttributeKit in_marker_attribute_kit)

Properties

HPS.MarkerAttributeKit marker_attribute_kit { get; set; }

HPS.SegmentKey segment_key { get; set; }

class MarkerImportEvent : public HPS.Stream.ImportEvent

Public Functions

override void Dispose ()

new IntPtr GetClassID ()

MarkerImportEvent ()

MarkerImportEvent (HPS.SegmentKey in_segment_key, HPS.MarkerKit in_marker_kit)

Properties

HPS.MarkerKit marker_kit { get; set; }

HPS.SegmentKey segment_key { get; set; }

class MaterialImportEvent : public HPS.Stream.ImportEvent

Public Functions

override void Dispose ()

new IntPtr GetClassID ()

MaterialImportEvent ()

MaterialImportEvent (HPS.Key in_key, HPS.MaterialMappingKit in_material_mapping_kit)

Properties

HPS.Key key { get; set; }

HPS.MaterialMappingKit material_mapping_kit { get; set; }

class MaterialPaletteDefinitionImportEvent : public HPS.Stream.ImportEvent

Public Functions

override void Dispose ()

new IntPtr GetClassID ()

MaterialPaletteDefinitionImportEvent ()

MaterialPaletteDefinitionImportEvent (HPS.PortfolioKey in_portfolio_key, string in_name, HPS.MaterialKit[] in_material_mapping_kit_array)

Properties

HPS.MaterialKit[] material_mapping_kit_array { get; set; }

string name { get; set; }

HPS.PortfolioKey portfolio_key { get; set; }

class MaterialPaletteImportEvent : public HPS.Stream.ImportEvent

Public Functions

override void Dispose ()

new IntPtr GetClassID ()

MaterialPaletteImportEvent ()

MaterialPaletteImportEvent (HPS.SegmentKey in_segment_key, string in_name)

Properties

string name { get; set; }

HPS.SegmentKey segment_key { get; set; }

class MatrixImportEvent : public HPS.Stream.ImportEvent

Public Functions

override void Dispose ()

new IntPtr GetClassID ()

MatrixImportEvent ()

MatrixImportEvent (HPS.Key in_key, HPS.MatrixKit in_matrix_kit)

Properties

HPS.Key key { get; set; }

HPS.MatrixKit matrix_kit { get; set; }

class MeshImportEvent : public HPS.Stream.ImportEvent

Public Functions

override void Dispose ()

new IntPtr GetClassID ()

MeshImportEvent ()

MeshImportEvent (HPS.SegmentKey in_segment_key, HPS.MeshKit in_mesh_kit)

Properties

HPS.MeshKit mesh_kit { get; set; }

HPS.SegmentKey segment_key { get; set; }

class MeshInstanceImportEvent : public HPS.Stream.ImportEvent

Public Functions

override void Dispose ()

new IntPtr GetClassID ()

MeshInstanceImportEvent ()

MeshInstanceImportEvent (HPS.SegmentKey in_segment_key, HPS.MeshKit in_mesh_kit, HPS.MatrixKit in_modelling_matrix)

Properties

HPS.MeshKit mesh_kit { get; set; }

HPS.MatrixKit modelling_matrix { get; set; }

HPS.SegmentKey segment_key { get; set; }

class NamedStyleDefinitionImportEvent : public HPS.Stream.ImportEvent

Public Functions

override void Dispose ()

new IntPtr GetClassID ()

NamedStyleDefinitionImportEvent ()

NamedStyleDefinitionImportEvent (HPS.PortfolioKey in_portfolio_key, string in_name, HPS.SegmentKey in_style_key)

Properties

string name { get; set; }

HPS.PortfolioKey portfolio_key { get; set; }

HPS.SegmentKey style_key { get; set; }

class NamedStyleImportEvent : public HPS.Stream.ImportEvent

Public Functions

override void Dispose ()

new IntPtr GetClassID ()

NamedStyleImportEvent ()

Properties

HPS.ConditionalExpression condition { get; set; }

HPS.AttributeLock.Type[] filter_types { get; set; }

string name { get; set; }

HPS.SegmentKey segment_key { get; set; }

class NonDBUserDataImportEvent : public HPS.Stream.ImportEvent

This class indicates non-database user data is being imported by Stream.

Public Functions

override void Dispose ()

new IntPtr GetClassID ()

NonDBUserDataImportEvent ()

NonDBUserDataImportEvent (byte[] in_data)

Properties

byte[] user_data { get; set; }

class NURBSCurveImportEvent : public HPS.Stream.ImportEvent

Public Functions

override void Dispose ()

new IntPtr GetClassID ()

NURBSCurveImportEvent ()

NURBSCurveImportEvent (HPS.SegmentKey in_segment_key, HPS.NURBSCurveKit in_nurbs_curve_kit)

Properties

HPS.NURBSCurveKit nurbs_curve_kit { get; set; }

HPS.SegmentKey segment_key { get; set; }

class NURBSSurfaceAttributeImportEvent : public HPS.Stream.ImportEvent

Public Functions

override void Dispose ()

new IntPtr GetClassID ()

NURBSSurfaceAttributeImportEvent ()

NURBSSurfaceAttributeImportEvent (HPS.SegmentKey in_segment_key, HPS.NURBSSurfaceAttributeKit in_nurbs_surface_attribute_kit)

Properties

HPS.NURBSSurfaceAttributeKit nurbs_surface_attribute_kit { get; set; }

HPS.SegmentKey segment_key { get; set; }

class NURBSSurfaceImportEvent : public HPS.Stream.ImportEvent

Public Functions

override void Dispose ()

new IntPtr GetClassID ()

NURBSSurfaceImportEvent ()

NURBSSurfaceImportEvent (HPS.SegmentKey in_segment_key, HPS.NURBSSurfaceKit in_nurbs_surface_kit)

Properties

HPS.NURBSSurfaceKit nurbs_surface_kit { get; set; }

HPS.SegmentKey segment_key { get; set; }

class PerformanceImportEvent : public HPS.Stream.ImportEvent

Public Functions

override void Dispose ()

new IntPtr GetClassID ()

PerformanceImportEvent ()

PerformanceImportEvent (HPS.SegmentKey in_segment_key, HPS.PerformanceKit in_performance_kit)

Properties

HPS.PerformanceKit performance_kit { get; set; }

HPS.SegmentKey segment_key { get; set; }

class PolygonImportEvent : public HPS.Stream.ImportEvent

Public Functions

override void Dispose ()

new IntPtr GetClassID ()

PolygonImportEvent ()

PolygonImportEvent (HPS.SegmentKey in_segment_key, HPS.PolygonKit in_polygon_kit)

Properties

HPS.PolygonKit polygon_kit { get; set; }

HPS.SegmentKey segment_key { get; set; }

class PriorityImportEvent : public HPS.Stream.ImportEvent

Public Functions

override void Dispose ()

new IntPtr GetClassID ()

PriorityImportEvent ()

PriorityImportEvent (HPS.Key in_key, int in_priority)

Properties

HPS.Key key { get; set; }

int priority { get; set; }

class ReferenceGeometryImportEvent : public HPS.Stream.ImportEvent

Public Functions

override void Dispose ()

new IntPtr GetClassID ()

ReferenceGeometryImportEvent ()

ReferenceGeometryImportEvent (HPS.SegmentKey in_segment_key, HPS.Key in_reference_geometry_key, HPS.ConditionalExpression in_conditional)

Properties

HPS.ConditionalExpression condition { get; set; }

HPS.Key reference_geometry_key { get; set; }

HPS.SegmentKey segment_key { get; set; }

class SegmentExportEvent : public HPS.Stream.ExportEvent

The SegmentExportEvent class indicates that a segment is about to be exported by Stream.

Public Functions

override void Dispose ()

new IntPtr GetClassID ()

SegmentExportEvent ()

SegmentExportEvent (HPS.SegmentKey in_segment_key)

Properties

HPS.SegmentKey segment_key { get; set; }

class SegmentImportEvent : public HPS.Stream.ImportEvent

Public Functions

override void Dispose ()

new IntPtr GetClassID ()

SegmentImportEvent ()

SegmentImportEvent (HPS.SegmentKey in_segment_key, string in_name)

Properties

string name { get; set; }

HPS.SegmentKey segment_key { get; set; }

class SelectabilityImportEvent : public HPS.Stream.ImportEvent

Public Functions

override void Dispose ()

new IntPtr GetClassID ()

SelectabilityImportEvent ()

SelectabilityImportEvent (HPS.SegmentKey in_segment_key, HPS.SelectabilityKit in_selectability_kit)

Properties

HPS.SegmentKey segment_key { get; set; }

HPS.SelectabilityKit selectability_kit { get; set; }

class ShapeDefinitionImportEvent : public HPS.Stream.ImportEvent

Public Functions

override void Dispose ()

new IntPtr GetClassID ()

ShapeDefinitionImportEvent ()

ShapeDefinitionImportEvent (HPS.PortfolioKey in_portfolio_key, string in_name, HPS.ShapeKit in_shape_kit)

Properties

string name { get; set; }

HPS.PortfolioKey portfolio_key { get; set; }

HPS.ShapeKit shape_kit { get; set; }

class ShellImportEvent : public HPS.Stream.ImportEvent

Public Functions

override void Dispose ()

new IntPtr GetClassID ()

ShellImportEvent ()

ShellImportEvent (HPS.SegmentKey in_segment_key, HPS.ShellKit in_shell_kit)

Properties

HPS.SegmentKey segment_key { get; set; }

HPS.ShellKit shell_kit { get; set; }

class ShellInstanceImportEvent : public HPS.Stream.ImportEvent

Public Functions

override void Dispose ()

new IntPtr GetClassID ()

ShellInstanceImportEvent ()

ShellInstanceImportEvent (HPS.SegmentKey in_segment_key, HPS.ShellKit in_shell_kit, HPS.MatrixKit in_modelling_matrix)

Properties

HPS.MatrixKit modelling_matrix { get; set; }

HPS.SegmentKey segment_key { get; set; }

HPS.ShellKit shell_kit { get; set; }

class SphereAttributeImportEvent : public HPS.Stream.ImportEvent

Public Functions

override void Dispose ()

new IntPtr GetClassID ()

SphereAttributeImportEvent ()

SphereAttributeImportEvent (HPS.SegmentKey in_segment_key, HPS.SphereAttributeKit in_sphere_attribute_kit)

Properties

HPS.SegmentKey segment_key { get; set; }

HPS.SphereAttributeKit sphere_attribute_kit { get; set; }

class SphereImportEvent : public HPS.Stream.ImportEvent

Public Functions

override void Dispose ()

new IntPtr GetClassID ()

SphereImportEvent ()

SphereImportEvent (HPS.SegmentKey in_segment_key, HPS.SphereKit in_sphere_kit)

Properties

HPS.SegmentKey segment_key { get; set; }

HPS.SphereKit sphere_kit { get; set; }

class SpotlightImportEvent : public HPS.Stream.ImportEvent

Public Functions

override void Dispose ()

new IntPtr GetClassID ()

SpotlightImportEvent ()

SpotlightImportEvent (HPS.SegmentKey in_segment_key, HPS.SpotlightKit in_spotlight_kit)

Properties

HPS.SegmentKey segment_key { get; set; }

HPS.SpotlightKit spotlight_kit { get; set; }

class StyleSegmentImportEvent : public HPS.Stream.ImportEvent

Public Functions

override void Dispose ()

new IntPtr GetClassID ()

StyleSegmentImportEvent ()

Properties

HPS.ConditionalExpression condition { get; set; }

HPS.AttributeLock.Type[] filter_types { get; set; }

HPS.SegmentKey segment_key { get; set; }

HPS.SegmentKey style_segment_key { get; set; }

class SubwindowImportEvent : public HPS.Stream.ImportEvent

Public Functions

override void Dispose ()

new IntPtr GetClassID ()

SubwindowImportEvent ()

SubwindowImportEvent (HPS.SegmentKey in_segment_key, HPS.SubwindowKit in_subwindow_kit)

Properties

HPS.SegmentKey segment_key { get; set; }

HPS.SubwindowKit subwindow_kit { get; set; }

class TextAttributeImportEvent : public HPS.Stream.ImportEvent

Public Functions

override void Dispose ()

new IntPtr GetClassID ()

TextAttributeImportEvent ()

TextAttributeImportEvent (HPS.SegmentKey in_segment_key, HPS.TextAttributeKit in_text_attribute_kit)

TextAttributeImportEvent (HPS.TextKey in_text_key, HPS.TextAttributeKit in_text_attribute_kit)

Properties

HPS.Key key { get; set; }

HPS.TextAttributeKit text_attribute_kit { get; set; }

class TextImportEvent : public HPS.Stream.ImportEvent

Public Functions

override void Dispose ()

new IntPtr GetClassID ()

TextImportEvent ()

TextImportEvent (HPS.SegmentKey in_segment_key, HPS.TextKit in_text_kit)

Properties

HPS.SegmentKey segment_key { get; set; }

HPS.TextKit text_kit { get; set; }

class TextureDefinitionImportEvent : public HPS.Stream.ImportEvent

Public Functions

override void Dispose ()

new IntPtr GetClassID ()

TextureDefinitionImportEvent ()

TextureDefinitionImportEvent (HPS.PortfolioKey in_portfolio_key, string in_name, HPS.ImageDefinition in_source_definition, HPS.TextureOptionsKit in_texture_kit)

Properties

string name { get; set; }

HPS.PortfolioKey portfolio_key { get; set; }

HPS.ImageDefinition source_definition { get; set; }

HPS.TextureOptionsKit texture_kit { get; set; }

class Toolkit : public HPS.Object

The Toolkit class is the primary support class which manages streaming of HSF data.

Public Functions

override void Dispose ()

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.

HPS.Stream.ImportNotifier ParseBuffers (byte[][] in_hsf_buffers, HPS.Stream.ImportOptionsKit in_options)

void Restart ()

Restarts the Toolkit object so that it can be reused for importing or exporting.

Toolkit ()

The Default constructor creates an empty Toolkit object.

Toolkit (HPS.Stream.Toolkit in_toolkit)

This constructor creates an Toolkit object that shares the underlying smart-pointer of the source Toolkit.

Param in_toolkit:  The source Toolkit to copy.

class TransformMaskImportEvent : public HPS.Stream.ImportEvent

Public Functions

override void Dispose ()

new IntPtr GetClassID ()

TransformMaskImportEvent ()

TransformMaskImportEvent (HPS.SegmentKey in_segment_key, HPS.TransformMaskKit in_transform_mask_kit)

Properties

HPS.SegmentKey segment_key { get; set; }

HPS.TransformMaskKit transform_mask_kit { get; set; }

class TransparencyImportEvent : public HPS.Stream.ImportEvent

Public Functions

override void Dispose ()

new IntPtr GetClassID ()

TransparencyImportEvent ()

TransparencyImportEvent (HPS.SegmentKey in_segment_key, HPS.TransparencyKit in_transparency_kit)

Properties

HPS.SegmentKey segment_key { get; set; }

HPS.TransparencyKit transparency_kit { get; set; }

class UserDataImportEvent : public HPS.Stream.ImportEvent

This class indicates that user data contained within the database (associated with either a segment or geometry key) is being imported by Stream.

Public Functions

override void Dispose ()

new IntPtr GetClassID ()

UserDataImportEvent ()

UserDataImportEvent (HPS.Key in_key, IntPtr in_index, byte[] in_data)

Properties

IntPtr index { get; set; }

HPS.Key key { get; set; }

byte[] user_data { get; set; }

class VisibilityImportEvent : public HPS.Stream.ImportEvent

Public Functions

override void Dispose ()

new IntPtr GetClassID ()

VisibilityImportEvent ()

VisibilityImportEvent (HPS.SegmentKey in_segment_key, HPS.VisibilityKit in_visibility_kit)

Properties

HPS.SegmentKey segment_key { get; set; }

HPS.VisibilityKit visibility_kit { get; set; }

class VisualEffectsImportEvent : public HPS.Stream.ImportEvent

Public Functions

override void Dispose ()

new IntPtr GetClassID ()

VisualEffectsImportEvent ()

VisualEffectsImportEvent (HPS.SegmentKey in_segment_key, HPS.VisualEffectsKit in_visual_effects_kit)

Properties

HPS.SegmentKey segment_key { get; set; }

HPS.VisualEffectsKit visual_effects_kit { get; set; }