HCA

class HPS.HCA : public IDisposable 

The HCA class contains objects used for importing Stream Cache files.

Public Functions

void Dispose ()

HCA (HPS.HCA in_that)

class File : public IDisposable 

The File class provides functions to import Stream Cache files.

Public Functions

void Dispose ()

File (HPS.HCA.File in_that)

Public Static Functions

HPS.HCA.ImportNotifier Import (string in_file_name, HPS.HCA.ImportOptionsKit in_options)

Performs an asynchronous local import of the specified Stream Cache file with the provided options. May throw an IOException prior to starting the asynchronous import. After the import has started it will take place on a separate thread. The status of the import can be checked using the returned ImportNotifier. It is possible to wait for the import to complete by using the Wait method from the returned ImportNotifier. While it is possible to interact with the scene’s camera even before the model has fully finished loading, attempting to select the model, highlight it, hide, isolate or show parts of it while it is being loaded will result in an exception being thrown.

Param in_file_name: The name of the file to import.
Param in_options: The options controlling the import of the Stream Cache file.
Return: An ImportNotifier object that can be used to query the import progress and status.

HPS.HCA.ImportNotifier Import (string in_file_name, HPS.HCA.NetworkImportOptionsKit in_options)

Performs an asynchronous import of the specified Stream Cache file with the provided options over the network. May throw an IOException prior to starting the asynchronous import. After the import has started it will take place on a separate thread. The Wait method from the returned ImportNotifier can be used to wait for the minimum necessary model data is imported. Once Wait returns, it is safe to interact with the model, even as geometry continues to stream in. Attempting to select, highlight, isolate, hide, or show parts of the model before Wait returns can result in an exception being thrown.

Param in_file_name: The name of the file to import.
Param in_options: The options controlling the import of the Stream Cache file.
Return: An ImportNotifier object that can be used to query the import progress and status.

class ImportNotifier : public HPS.IONotifier 

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

Public Functions

void Assign (HPS.HCA.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.Model GetTarget ()

Get the the Model where the Stream Cache file was imported into. Throws an IOException if the import is not complete or was not successful.

Return: The Model containing the Stream Cache file for a successful file import.

ImportNotifier (): The default constructor creates an ImportNotifier object which is not tied to any file import.

ImportNotifier (HPS.HCA.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.

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.

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.Sprocket 

The HPS.HCA.ImportOptionsKit class is a user space object. It contains settings controlling what and how Stream Cache data is imported via the HCA Sprocket.

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.HCA.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.HCA.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.HCA.ImportOptionsKit in_kit)

Copies the source ImportOptionsKit into this ImportOptionsKit.

Param in_kit: The source ImportOptionsKit to copy.

HPS.HCA.ImportOptionsKit SetJavascriptPath (string javascript_path)

HPS.HCA.ImportOptionsKit SetTarget (HPS.Model in_target)

Sets a Model to be used as part of the import. Geometry will be imported in the model Segment, and definitions will be added to the Portfolio associated with the Model provided. Setting a target is required for the import to succeed.

Return: A reference to this ImportOptionsKit.

HPS.HCA.ImportOptionsKit SetView (HPS.View in_view)

Sets a View to be used as part of the import. Setting a View is required for the import to succeed.

Param in_view: View to use for camera tracking.
Return: A reference to this ImportOptionsKit.

void Show (out HPS.HCA.ImportOptionsKit out_kit)

Copies this ImportOptionsKit into the given ImportOptionsKit.

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

bool ShowJavascriptPath (out string out_javascript_path)

Shows the path that will be used to find hc_access.js during import.

Param out_javascript_path: The path used to reach hc_access.js.
Return: Returns false if a javascript path setting was not specified, false otherwise.

bool ShowTarget (out HPS.Model out_model)

Shows the target import setting.

Param out_model: Model to use to implicitly set Segment, Library and Portfolio into which the data will be imported.
Return: Returns false if a target setting was not specified, false otherwise.

bool ShowView (out HPS.View out_view)

Shows the view import setting.

Param out_view: View to use.
Return: Returns false if a view setting was not specified, false otherwise.

HPS.HCA.ImportOptionsKit UnsetEverything ()

Removes all settings from this ImportOptionsKit.

Return: A reference to this ImportOptionsKit.

HPS.HCA.ImportOptionsKit UnsetJavascriptPath ()

Removes javascript path import setting.

Return: A reference to this ImportOptionsKit.

HPS.HCA.ImportOptionsKit UnsetTarget ()

Removes the target import setting.

Return: A reference to this ImportOptionsKit.

HPS.HCA.ImportOptionsKit UnsetView ()

Removes the view import setting.

Return: A reference to this ImportOptionsKit.

Public Static Functions

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

Return: An ImportOptionsKit with the default settings.

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

bool operator== (HPS.HCA.ImportOptionsKit a, HPS.HCA.ImportOptionsKit b)

struct InstanceInc

Public Functions

bool Equals (InstanceInc p)

override bool Equals (object obj)

override int GetHashCode ()

Public Members

UInt32 inclusion_key

UInt32 instance_key

Public Static Functions

bool operator!= (InstanceInc p1, InstanceInc p2)

bool operator== (InstanceInc p1, InstanceInc p2)

class Model : public IDisposable 

The Model class provides interactions with a HCAModel

Public Functions

void Dispose ()

bool Empty ()

Checks the state of the Model.

Return: true if this Model is uninitialized, false otherwise.

bool Equals (HPS.HCA.Model other)

Check if the source Model is equivalent to this Model.

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

override bool Equals (Object obj)

override int GetHashCode ()

void Hide (HPS.Canvas in_canvas, Int64 in_node_id)

Hides the specified node under the given Canvas. This makes the selected node invisible. throws HPS.InvalidObjectException is the Model is uninitialized.

Param in_canvas: The Canvas in which to hide the node.
Param in_node_id: The ID of the node to be hidden

void Highlight (HPS.Canvas in_canvas, HPS.HighlightOptionsKit in_highlight_options, Int64 in_node_id)

Highlights the specified node under the given Canvas, using the options provided. throws HPS.InvalidObjectException is the Model is uninitialized.

Param in_canvas: The Canvas in which to highlight the node.
Param in_highlight_options: The options to be used when highlighting in_node_id.
Param in_node_id: The ID of the node to be highlighted

void Highlight (HPS.Canvas in_canvas, HPS.HighlightOptionsKit in_highlight_options, Int64[] in_node_ids)

Highlights the specified nodes under the given Canvas, using the options provided. All specified nodes will be highlighted using the same options. throws HPS.InvalidObjectException is the Model is uninitialized.

Param in_canvas: The Canvas in which to highlight the nodes.
Param in_highlight_options: The options to be used when highlighting in_node_ids.
Param in_node_ids: an array of node IDs to be highlighted

bool IsHidden (Int64 in_node_id)

Checks whether the given node is currently Hidden as a result of a Hide or Isolate operation. throws HPS.InvalidObjectException is the Model is uninitialized.

Param in_node_id: The ID of the node to examine.
Return: true if the node is hidden, false otherwise.

bool IsHighlighted (Int64 in_node_id)

Checks whether the given node is currently highlighted. throws HPS.InvalidObjectException is the Model is uninitialized.

Param in_node_id: The ID of the node to examine.
Return: true if the node is highlighted, false otherwise.

void Isolate (HPS.Canvas in_canvas, Int64 in_node_id)

Shows only the specified node and hides the rest. throws HPS.InvalidObjectException is the Model is uninitialized.

Param in_canvas: The Canvas in which to isolate the node.
Param in_node_id: The ID of the node to isolate.

Model (): Constructs an uninitialized HCA.Model.

Model (HPS.HCA.Model that): Copy constructor. This constructor creates an HCA.Model which shares the same resources of the source HCA.Model.

Model (HPS.Model in_model)

Constructs a HCA.Model under an existing HPS.Model.

Param in_model: the HPS.Model under which to create an HCA.Model.

void OnHighlightUnhighlight (): This convenience function performs the HCA.ModelTreeItem.OnHighlightUnhighlight function on the root item of the Model Tree See the description of HCA.ModelTreeItem.OnHighlightUnhighlight for more information.

bool RequestNodeProperties (Int64 in_node_id, out UInt32 out_request_id)

Requests properties for the specified node. throws HPS.InvalidObjectException is the Model is uninitialized. When the request has been fulfilled, an event of type HCA.RequestIdEvent will be injected to the Database’s Event Dispatcher. Registering a handler to HCA.RequestIdEvent will allow the user to know when this request has completed. The value of HCA.RequestIdEvent.request_id object will match out_requested_id, returned by this function.

Param in_node_id: the ID for the node whose properties should be collected.
Param out_request_id: an ID which uniquely identifies this request
Return: true if the node’s properties were gathered successfully, false otherwise.

bool RetrieveNodeProperties (UInt32 in_request_id, UInt32 in_timeout_ms, out Int64 out_node_id, out bool out_valid, out string[] out_keys, out string[] out_values)

void Show (HPS.Canvas in_canvas, Int64 in_node_id)

Shows the specified node under the given Canvas. This makes the selected node visible. throws HPS.InvalidObjectException is the Model is uninitialized.

Param in_canvas: The Canvas in which to show the node.
Param in_node_id: The ID of the node to be shown

void ShowAll (HPS.Canvas in_canvas)

Shows all nodes in the model, under the specified Canvas. throws HPS.InvalidObjectException is the Model is uninitialized.

Param in_canvas: The Canvas in which to show the nodes.

bool ShowNodeChildren (Int64 in_node_id, out Int64[] out_ids)

Shows the IDs of the children of the requested node. throws HPS.InvalidObjectException is the Model is uninitialized.

Param in_node_id: the ID for the node whose children should be shown
Param out_ids: an array of IDs representing the children of in_node_id.
Return: true if the node’s children were found successfully, false otherwise.

bool ShowNodeFromKeyPath (HPS.KeyPath in_key_path, out Int64 out_node_id)

Given a KeyPath, the associated node ID is returned.

Param in_key_path: the key path for which a node ID is being requested
Param out_node_id: the node ID that corresponds to in_key_path
Return: true if the node ID is associated to in_key_path, false otherwise.

bool ShowNodeName (Int64 in_node_id, out string out_name)

Shows the name for the requested node. throws HPS.InvalidObjectException is the Model is uninitialized.

Param in_node_id: the ID for the node whose name should be shown
Param out_name: the name of in_node_id, in the UTF8 locale. Might be an empty UTF8 object.
Return: true if the node name was found successfully, false otherwise.

bool ShowNodeParent (Int64 in_node_id, out Int64 out_parent_id)

Shows the ID of the parent of the requested node. throws HPS.InvalidObjectException is the Model is uninitialized.

Param in_node_id: the ID for the node whose parent should be shown
Param out_parent_id: the ID representing the parent of in_node_id. Might be an empty array
Return: true if the node’s parent was found successfully, false otherwise.

bool ShowRootNode (out Int64 out_node_id)

Shows the node ID for the root node of the Model. throws HPS.InvalidObjectException is the Model is uninitialized.

Param out_node_id: the node ID for the root node of the Model.
Return: true if the root node ID was found, false otherwise.

void Unhighlight (HPS.Canvas in_canvas, Int64 in_node_id)

Unhighlights the specified node under the given Canvas. throws HPS.InvalidObjectException is the Model is uninitialized.

Param in_canvas: The Canvas in which to unhighlight the node.
Param in_node_id: The ID of the node to be unhighlighted

void UnhighlightAll (HPS.Canvas in_canvas)

Unhighlights all nodes in the model, under the specified Canvas. throws HPS.InvalidObjectException is the Model is uninitialized.

Param in_canvas: The Canvas in which to unhighlight the nodes.

void Zoom (HPS.Canvas in_canvas, Int64 in_node_id)

Smoothly zooms the camera to focus on the specified node. The transition lasts half a second. throws HPS.InvalidObjectException is the Model is uninitialized.

Param in_canvas: The Canvas in which to zoom to the node.
Param in_node_id: The ID of the node to zoom to.

Public Static Functions

bool operator!= (HPS.HCA.Model a, HPS.HCA.Model b)

bool operator== (HPS.HCA.Model a, HPS.HCA.Model b)

class ModelTree : public HPS.Sprocket 

The ModelTree class is a smart pointer which corresponds to a tree object in a GUI toolkit, e.g., a TreeView in WPF or a CTreeCtrl in MFC. This class can be derived from to facilitate tree creation in the various GUI toolkits. It is used to create a model browser.

Public Types

enum ItemType

Enumerates the types of items that can be contained in a ModelTree.

Values:

None: No type.

Model: Item is an HCA.Model.

Node: Item is an HCA.Node.

Public Functions

void Assign (HPS.HCA.ModelTree in_that)

Share the underlying smart-pointer of the ModelTree source.

Param in_that: The ModelTree source of the assignment.
Return: A reference to this ModelTree.

override void Dispose ()

delegate void DtorDelegate (IntPtr cPtr)

bool Equals (HPS.HCA.ModelTree in_that)

Check if the source ModelTree points to the same underlying impl as this ModelTree.

Param in_that: The source ModelTree to compare to this ModelTree.
Return: true if the objects reference the same underlying data, false otherwise.

override bool Equals (Object obj)

void Flush (): Resets the root ModelTreeItem for this ModelTree. This will release the root ModelTreeItem by this ModelTree and set the root to a null pointer. If this function is overridden, the overriding function should invoke this base function.

HPS.Canvas GetCanvas ()

Gets the Canvas associated with this ModelTree.

Return: The Canvas associated with this ModelTree.

override int GetHashCode ()

HPS.HCA.Model GetHCAModel ()

Gets the HCAModel associated with this ModelTree.

Return: The HCAModel associated with this ModelTree.

HPS.HCA.ModelTreeItem GetRoot ()

Gets the root ModelTreeItem for this ModelTree.

Return: The root ModelTreeItem for this ModelTree.

ModelTree (): The default constructor creates an uninitialized ModelTree object. The Type() function will return Type.None.

ModelTree (HPS.Canvas in_canvas, HPS.HCA.Model hca_model)

This constructor creates a ModelTree object associated with a Canvas and the specified HCA.Model. This constructor should be used to create a new ModelTree object.

Param in_canvas: The Canvas to associate this ModelTree with.
Param hca_model: The model to associate this ModelTree with.

ModelTree (HPS.HCA.ModelTree in_that)

The copy constructor creates a ModelTree object that shares the underlying smart-pointer of the source ModelTree.

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

delegate void RemoveCacheItemDelegate (IntPtr cPtr)

void SetRoot (HPS.HCA.ModelTreeItem in_root)

Sets the root ModelTreeItem for this ModelTree. This object should be created on the heap and it should have been created with a ModelTreeItem constructor which took an HCA.Model, otherwise an exception will be thrown. Additionally, if there was already an existing root for this ModelTree, the Flush function will be invoked prior to setting this as the new root, and ModelTreeItem.Expand will be invoked on the new root.

See: Flush
See: ModelTreeItem.Expand

Param in_root: The root ModelTreeItem for this ModelTree.

Public Static Functions

bool operator!= (HPS.HCA.ModelTree a, HPS.HCA.ModelTree b)

bool operator== (HPS.HCA.ModelTree a, HPS.HCA.ModelTree b)

class ModelTreeItem : public HPS.Sprocket 

The ModelTreeItem class is a smart pointer which corresponds to an item or node in a tree object in a GUI toolkit, e.g., a TreeViewItem in WPF or an HTREEITEM in MFC. This class must be derived from to facilitate tree creation in the various GUI toolkits. It is used to represent items in a model browser.

Subclassed by HPS.HCA.ModelTreeItem.ModelTreeItemUnknown

Public Functions

abstract HPS.HCA.ModelTreeItem AddChild (Int64 in_node_id)

This function is used to create a new ModelTreeItem to be the child of this ModelTreeItem. You will need to implement this function in your class which derives from HCA.ModelTreeItem. This function will be invoked if this ComponentTreeItem has children and Expand has been invoked on it. This function should contain any necessary calls to GUI toolkits to create the appropriate GUI elements. Additionally, since this function requires the creation of a derived ModelTreeItem, that derived ModelTreeItem should use the base constructor which is appropriate for creating non-root items.

Param in_node_id: The node ID to be associated with the ModelTreeItem being added to the ModelTree.

void Assign (HPS.HCA.ModelTreeItem in_that)

Share the underlying smart-pointer of the ModelTreeItem source.

Param in_that: The ModelTreeItem source of the assignment.
Return: A reference to this ModelTreeItem.

void Collapse (): This function should be invoked when this ModelTreeItem needs to collapse. If this function is overridden, the overriding function should invoke this base function. Additionally, this function will always release all children for this ModelTreeItem when invoked.

override void Dispose ()

delegate void DtorDelegate (IntPtr cPtr)

bool Equals (HPS.HCA.ModelTreeItem in_that)

Check if the source ModelTreeItem points to the same underlying impl as this ModelTreeItem.

Param in_that: The source ModelTreeItem to compare to this ModelTreeItem.
Return: true if the objects reference the same underlying data, false otherwise.

override bool Equals (Object obj)

void Expand (): This function should be invoked when this ModelTreeItem needs to expand. If this function is overridden, the overriding function should invoke this base function. Additionally, this function will always repopulate the children for this ModelTreeItem when invoked.

override int GetHashCode ()

HPS.HCA.ModelTree.ItemType GetItemType ()

Gets the item type for this ModelTreeItem. This is used to determine what type of data this ModelTreeItem represents in the ModelTree.

Return: The item type for this ModelTreeItem.

UInt64 GetNodeId ()

Returns the HCA node ID associated with this ModelTreeItem

Return: The HCA node ID associated with this ModelTreeItem .

string GetTitle ()

Gets the title for this ModelTreeItem. This is the text that should be displayed for this ModelTreeItem in the ModelTree.

Return: The title for this ModelTreeItem.

HPS.HCA.ModelTree GetTree ()

Gets the ModelTree associated with this ModelTreeItem. This provides a means of accessing the derived ModelTree by this ModelTreeItem if necessary.

Return: The ModelTree associated with this ModelTreeItem.

bool HasChildren ()

Indicates whether this ModelTreeItem has any children.

Return: true if this ModelTreeItem has children, false otherwise.

void Hide (): Hides this ModelTreeItem it isn’t already. Geometry associated with a hidden ModelTreeItem becomes invisible. Calling this function will result in a call to OnShowHide after the hide operation has taken place.

void Highlight (HPS.HighlightOptionsKit in_highlight_options): Highlights this ModelTreeItem using the options specified. Calling this function will result in a call to OnHighlightUnhighlight after the highlight operation has taken place.

bool IsExpanded ()

Indicates whether this ModelTreeItem is currently expanded.

Return: true if this ModelTreeItem is expanded, false otherwise.

bool IsHidden ()

Indicates whether this ModelTreeItem is currently hidden.

Return: true if this ModelTreeItem is hidden, false otherwise.

bool IsHighlighted ()

Indicates whether this ModelTreeItem is currently highlighted.

Return: true if this ModelTreeItem is highlighted, false otherwise.

void Isolate (): Shows this ModelTreeItem and hides every other nodes in the tree, causing this item to become the only one visible. The camera will zoom to the isolated item. Calling this function will result in a call to OnShowHide for the item which is isolated, after the isolate operation has taken place.

ModelTreeItem (): The default constructor creates an uninitialized ModelTreeItem object. The Type() function will return Type.None.

ModelTreeItem (HPS.HCA.ModelTree in_tree, HPS.HCA.Model in_hca_model)

This constructor creates a ModelTreeItem suitable for acting as a root in a ModelTree.

Param in_tree: A pointer to the ModelTree which will contain this ModelTreeItem
Param in_hca_model: The HCA.Model which will be assigned to this ModelTreeItem.

ModelTreeItem (HPS.HCA.ModelTree in_tree, Int64 in_node_id)

This constructor creates a ModelTreeItem which is not suitable for acting as a root in a ModelTree, but is suitable to be a ModelTreeItem under the root of the ModelTree. This constructor should be the one invoked in the overridden AddChild function.

Param in_tree: A pointer to the ModelTree which will contain this ModelTreeItem.
Param in_node_id: The node ID to be associated with this ModelTreeItem.

ModelTreeItem (HPS.HCA.ModelTreeItem in_that)

The copy constructor creates a ModelTreeItem object that shares the underlying smart-pointer of the source ModelTreeItem.

Param in_that: The source ModelTreeItem 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 OnHighlightUnhighlight (): This function will be invoked when this item becomes highlighted or unhighlighted. If you want something to happen when an item’s highlight state changes you should provide an implementation for this function in your class which derives from HCA.ModelTreeItem. A common usage for this function is to make the text associated with highlighted items bold to indicate to users whether the item is highlighted or not at a glance.

void OnShowHide (): This function will be invoked when this item becomes shown or hidden. If you want something to happen when an item becomes shown or hidden you should provide an implementation for this function in your class which derives from HCA.ModelTreeItem. A common usage for this function is to change the icon associated with the node to indicate to users whether the item is shown or hidden at a glance.

delegate void RemoveCacheItemDelegate (IntPtr cPtr)

bool RequestProperties (out UInt32 out_request_id)

void Show (): Shows this ModelTreeItem it isn’t already visible. Geometry associated with a shown ModelTreeItem becomes visible. Calling this function will result in a call to OnShowHide after the show operation has taken place.

void Unhighlight (): Removes all highlights from this ModelTreeItem. Calling this function will result in a call to OnHighlightUnhighlight after the unhighlight operation has taken place.

void Zoom (): Smoothly zooms the camera to focus on this item. The transition lasts half a second.

Public Static Functions

bool operator!= (HPS.HCA.ModelTreeItem a, HPS.HCA.ModelTreeItem b)

bool operator== (HPS.HCA.ModelTreeItem a, HPS.HCA.ModelTreeItem b)

class NetworkImportOptionsKit : public HPS.Sprocket 

The HPS.HCA.NetworkImportOptionsKit class is a user space object. It contains settings controlling what and how Stream Cache data is imported over a network via the HCA Sprocket.

Public Functions

override void Dispose ()

override bool Empty ()

Indicates whether this NetworkImportOptionsKit has any values set on it.

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

bool Equals (HPS.HCA.NetworkImportOptionsKit in_kit)

Check if the source NetworkImportOptionsKit is equivalent to this NetworkImportOptionsKit.

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

override bool Equals (Object obj)

override int GetHashCode ()

NetworkImportOptionsKit (): The default constructor creates an empty NetworkImportOptionsKit object.

NetworkImportOptionsKit (HPS.HCA.NetworkImportOptionsKit in_kit)

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

Param in_kit: The source NetworkImportOptionsKit 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.HCA.NetworkImportOptionsKit in_kit)

Copies the source NetworkImportOptionsKit into this NetworkImportOptionsKit.

Param in_kit: The source NetworkImportOptionsKit to copy.

HPS.HCA.NetworkImportOptionsKit SetEjectedGeometryBoundingPreviews (bool ejected_geometry_bounding_previews)

Whether to display a bounding mesh to replace geometry that was ejected because of the memory limit being hit. Additionally this option will only be honored if a memory limit is set.

Param ejected_geometry_bounding_previews: Whether ejected geometry should be replaced with boundings.
Return: A reference to this NetworkImportOptionsKit.

HPS.HCA.NetworkImportOptionsKit SetJavascriptPath (string javascript_path)

HPS.HCA.NetworkImportOptionsKit SetLimitMiB (UInt32 limit_MiB)

Sets the memory amount to devote to geometry data, specified in Megabytes. Passing a value of zero to this function is equivalent to calling UnsetLimitMib() Reaching the memory limit will cause some geometry to be ejected from the scene so that more can stream in.

Param limit_MiB: Memory in Megabytes to use for geometry data.
Return: A reference to this NetworkImportOptionsKit.

HPS.HCA.NetworkImportOptionsKit SetModelBoundingPreviews (bool model_bounding_previews)

Whether to load and display previews of the model bounding when streaming starts. As actual geometry starts streaming in, it will replace its bounding.

Param model_bounding_previews: Whether model boundings will be streamed.
Return: A reference to this NetworkImportOptionsKit.

HPS.HCA.NetworkImportOptionsKit SetNetworkPath (string network_path)

HPS.HCA.NetworkImportOptionsKit SetTarget (HPS.Model in_target)

Sets a Model to be used as part of the import. Geometry will be imported in the model Segment, and definitions will be added to the Portfolio associated with the Model provided. Setting a target is required for the import to succeed.

Return: A reference to this NetworkImportOptionsKit.

HPS.HCA.NetworkImportOptionsKit SetView (HPS.View in_view)

Sets a View to be used as part of the import. Setting a View is required for the import to succeed.

Param in_view: View to use for camera tracking.
Return: A reference to this NetworkImportOptionsKit.

void Show (out HPS.HCA.NetworkImportOptionsKit out_kit)

Copies this NetworkImportOptionsKit into the given NetworkImportOptionsKit.

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

bool ShowEjectedGeometryBoundingPreviews (out bool out_ejected_geometry_bounding_previews)

Shows the ejected bounding previews import setting.

Param out_ejected_geometry_bounding_previews: Whether ejected geometry should be replaced with a visualization of its boundings.
Return: Returns false if an ejected bounding preview setting was not specified false otherwise.

bool ShowJavascriptPath (out string out_javascript_path)

Shows the path that will be used to find hc_access.js during import.

Param out_javascript_path: The path used to reach hc_access.js.
Return: Returns false if a javascript path setting was not specified, false otherwise.

bool ShowLimitMiB (out UInt32 out_limit_MiB)

Shows the memory limit import setting.

Param out_limit_MiB: The amount of memory, specified in Megabytes, to use for geometry data.
Return: Returns false if a memory limit setting was not specified, false otherwise.

bool ShowModelBoundingPreviews (out bool out_model_bounding_previews)

Shows the model bounding preview import setting.

Param out_model_bounding_previews: Whether boundings should be visualized while waiting for geometry to stream in.
Return: Returns false if a model bounding preview setting was not specified, false otherwise.

bool ShowNetworkPath (out string out_network_path)

Shows the network path import setting.

Param out_network_path: The network path to use during the import.
Return: Returns false if a network path setting was not specified, false otherwise.

bool ShowTarget (out HPS.Model out_model)

Shows the target import setting.

Param out_model: Model to use to implicitly set Segment, Library and Portfolio into which the data will be imported.
Return: Returns false if a target setting was not specified, false otherwise.

bool ShowView (out HPS.View out_view)

Shows the view import setting.

Param out_view: View to use.
Return: Returns false if a view setting was not specified, false otherwise.

HPS.HCA.NetworkImportOptionsKit UnsetEjectedGeometryBoundingPreviews ()

Removes ejected bounding previews setting import setting.

Return: A reference to this NetworkImportOptionsKit.

HPS.HCA.NetworkImportOptionsKit UnsetEverything ()

Removes all settings from this NetworkImportOptionsKit.

Return: A reference to this NetworkImportOptionsKit.

HPS.HCA.NetworkImportOptionsKit UnsetJavascriptPath ()

Removes javascript path import setting.

Return: A reference to this NetworkImportOptionsKit.

HPS.HCA.NetworkImportOptionsKit UnsetLimitMiB ()

Removes the geometry data memory limit import setting.

Return: A reference to this NetworkImportOptionsKit.

HPS.HCA.NetworkImportOptionsKit UnsetModelBoundingPreviews ()

Removes model bounding previews setting import setting.

Return: A reference to this NetworkImportOptionsKit.

HPS.HCA.NetworkImportOptionsKit UnsetNetworkPath ()

Removes network path import setting.

Return: A reference to this NetworkImportOptionsKit.

HPS.HCA.NetworkImportOptionsKit UnsetTarget ()

Removes the target import setting.

Return: A reference to this NetworkImportOptionsKit.

HPS.HCA.NetworkImportOptionsKit UnsetView ()

Removes the view import setting.

Return: A reference to this NetworkImportOptionsKit.

Public Static Functions

HPS.HCA.NetworkImportOptionsKit GetDefault ()

Creates an NetworkImportOptionsKit 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.

Return: An NetworkImportOptionsKit with the default settings.

bool operator!= (HPS.HCA.NetworkImportOptionsKit a, HPS.HCA.NetworkImportOptionsKit b)

bool operator== (HPS.HCA.NetworkImportOptionsKit a, HPS.HCA.NetworkImportOptionsKit b)

class RequestIdEvent : public HPS.Event 

The RequestIdEvent class is the event that will be triggered for each HCAModel Request call.

Public Functions

override HPS.Event Clone ()

Allocates and returns a copy of this RequestIdEvent.

Return: A copy of this RequestIdEvent.

override void Dispose ()

RequestIdEvent (): The default constructor creates an empty RequestIdEvent object.

RequestIdEvent (HPS.Event in_event)

This constructor converts an Event Object to a RequestIdEvent object.

Param in_event: The Event Object to be converted.

RequestIdEvent (HPS.HCA.RequestIdEvent in_that)

RequestIdEvent (UInt32 in_request_id)

Properties

UInt32 request_id { get; set; }