Namespaces | Classes | Enumerations
Package HPS

Namespaces

package  hps
 
package  sprk
 
package  sprk_exchange
 
package  sprk_ops
 
package  sprk_parasolid
 
package  sprk_publish
 
package  sprk_sketchup
 

Classes

class  AbstractMethodException
 Thrown if an abstract (pure virtual) method was called directly. More...
 
class  AnnotationKitArray
 
class  ApplicationWindowKey
 The ApplicationWindowKey class is a smart pointer to a database object. It is a handle to an application window Visualize can draw into. More...
 
class  ApplicationWindowOptionsControl
 The HPS::ApplicationWindowOptionsControl class is a smart pointer that is tied to a database object. It is used to query and manipulate options pertaining to an HPS::ApplicationWindowKey. Default values for the various fields of HPS::ApplicationWindowOptionsControl can be found here. More...
 
class  ApplicationWindowOptionsKit
 The ApplicationWindowOptionsKit class is a user space object. It is used to specify application-window-specific options. Calling HPS::ApplicationWindowOptionsKit::GetDefault() will return a kit with values found in this table. More...
 
class  AttributeLock
 
class  AttributeLockControl
 The HPS::AttributeLockControl class provides support for attribute locking, which allows temporarily override of an attribute setting for a segment and its descendants. This control is used to set and unset attribute locks at the segment level. For more information, see Core Graphics Programming Guide, section 1.2.4 - subsection "Attribute controls". This table lists default values for the various segment attributes accessible from HPS::AttributeLockControl. More...
 
class  AttributeLockKit
 The HPS::AttributeLockKit class provides support for attribute locking, which allows temporarily override of an attribute setting for a segment and its descendants. This control is used to set and unset attribute locks at the segment level. Calling HPS::AttributeLockKit::GetDefault() will return a kit with values found in this table. More...
 
class  AttributeLockTypeArray
 
class  AxisTriadControl
 The AxisTriadControl allows you to turn on or off the axis triad, move it to a specific corner of the screen, change the material palette used to style it, or otherwise manipulate it. More...
 
class  AxisTriadOperator
 The AxisTriadOperator class defines an operator which allows the user to interact with the axis triad. This Operator works for both mouse- and touch-driven devices. Mouse-Driver Devices: Left Double Click: Double clicking on an axis snaps the view to that plane Left Button Down and Move: Rotates the scene Touch-Driven Devices: Double Tap: Double tapping on an axis snaps the view to that plane Tap and Move: Rotates the scene More...
 
class  BlankLinePatternElement
 The BlankLinePatternElement class is a user space object. It is used for specifying blank elements within a line pattern. More...
 
class  BoolArray
 
class  BooleanMetadata
 The BooleanMetadata class is a smart pointer. It represents a piece of boolean Metadata. More...
 
class  Bounding
 This is the Bounding Class
 
class  BoundingControl
 The HPS::BoundingControl class is a smart pointer that is tied to a database object. This object allows you to manipulate settings related to bounding, such as volume and exclusion. This table lists default values for the various segment attributes accessible from HPS::BoundingControl. More...
 
class  BoundingKit
 The HPS::BoundingKit class is a user space object, useful for carrying a group of attribute settings. Calling HPS::BoundingKit::GetDefault() will return a kit with values found in this table. More...
 
class  ButtonKitArray
 
class  ByteArray
 
class  ByteArrayArray
 
class  CADModel
 The CADModel class is a smart pointer. It represents the root Component for a structured file format. More...
 
class  CADModelArray
 
class  Camera
 This is the Camera Class
 
class  CameraControl
 The HPS::CameraControl class is a smart pointer that is tied to a database object. The CameraControl is used to manipulate the viewpoint, or camera, in a scene. Using this control, the view position, orientation, target, and aspect ratio of a segment's camera can be set. Cameras are considered segment attributes, but unlink other attributes, they inherit as a group down the segment hierarchy. This table lists default values for the various segment attributes accessible from HPS::CameraControl. More...
 
class  CameraKit
 The HPS::CameraKit class is a user space object, useful for carrying a group of attribute settings. Calling HPS::CameraKit::GetDefault() will return a kit with values found in this table. More...
 
class  CameraKitArray
 
struct  CameraPoint
 
class  CameraPointArray
 
class  Canvas
 The Canvas class is one of the four core display classes used in a Visualize application. It is meant to be used as part of a display hierarchy along with the Layout, View, and Model objects. The Canvas is the top-level object of the hierarchy and roughly correlates to a window. The Canvas is backed by an HPS::WindowKey. More...
 
class  CanvasArray
 
class  CanvasDeletedEvent
 
class  Capture
 The Capture class is a smart pointer. It represents a capture, i.e., a collection of visibility settings, material settings, transformation settings, and camera, for a CADModel. More...
 
class  CaptureActivationEvent
 
class  CaptureArray
 
class  CheckBoxKitArray
 
class  CircleKey
 The CircleKey class is a smart pointer to a database object. It is a handle to a circle inserted via SegmentKey::InsertCircle. A circle has face geometry contained within its circumference. The visualization of the circle will be determined by attribute settings affecting faces and edges. More...
 
class  CircleKit
 The HPS::CircleKit class is a user space object. It is a kit analog to a HPS::CircleKey. More...
 
class  CircularArcGlyphElement
 The CircularArcGlyphElement class is a user space object. It is used to add circular arc elements to a glyph. More...
 
class  CircularArcKey
 The CircularArcKey class is a smart pointer to a database object. It is handle to a circular arc inserted via SegmentKey::InsertCircularArc. A circular arc is the line geometry, as such its visualization will be determined by attributes affecting lines. More...
 
class  CircularArcKit
 The CircularArcKit class is a user space object. It is a kit analog to a CircularArcKey. More...
 
class  CircularWedgeKey
 The CircularWedgeKey class is a smart pointer to a database object. It is a handle to a circular wedge inserted via SegmentKey::InsertCircularWedge. A circular wedge has face geometry contained within the boundary edges of the circular wedge. The visualization of the wedge will be determined by attribute settings affecting faces and edges. More...
 
class  CircularWedgeKit
 The CircularWedgeKit class is a user space object. It is a kit analog to a CircularWedgeKey. More...
 
class  ColorInterpolationControl
 The HPS::ColorInterpolationControl class is a smart pointer that is tied to a database object. This class is the interface that allows you to manipulate whether color is interpolated over faces and edges. This table lists default values for the various segment attributes accessible from HPS::ColorInterpolationControl. More...
 
class  ColorInterpolationKit
 The HPS::ColorInterpolationKit class is a user space object, useful for carrying a group attribute settings. Calling HPS::ColorInterpolationKit::GetDefault() will return a kit with values found in this table. More...
 
class  Component
 The Component class is a smart pointer. It represents an arbitrary component of a structured file. More...
 
class  ComponentArray
 
class  ComponentHighlightEvent
 The ComponentHighlightEvent class is the event that will be triggered for each highlight or unhighlight call. More...
 
class  ComponentPath
 The ComponentPath contains an array of keys, organized from leaf to root. It allows the user to perform a number of queries along that path including accumulating net attributes and converting coordinates. More...
 
class  ComponentPathArray
 
class  ComponentTree
 The ComponentTree 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 component or model browser. More...
 
class  ComponentTreeItem
 The ComponentTreeItem 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 component or model browser. More...
 
class  Condition
 A Condition is a string or collection of strings separated by logical operators. In practice, conditions form a tree with the leaves being strings (the actual Condition) and the interior nodes being logical operators. More...
 
class  ConditionArray
 
class  ConditionControl
 The ConditionControl class is a smart pointer that is tied to a database object. This class is used to set and unset conditions on a segment. A condition can be used to control when a style is applied, or to control when an included segment is included. More...
 
class  ConfigurationArray
 
class  ConstructRectangleOperator
 
class  ContourLine
 This is the ContourLine Class
 
class  ContourLineControl
 The HPS::ContourLineControl class is a smart pointer that is tied to a database object. As its name suggests, this object can be used to control the various attributes related to contour lines, such as pattern, position, color, and weight. This table lists default values for the various segment attributes accessible from HPS::ContourLineControl. More...
 
class  ContourLineKit
 The HPS::ContourLineKit class is a user space object, useful for carrying a group of attribute settings. Calling HPS::ContourLineKit::GetDefault() will return a kit with values found in this table. More...
 
class  Control
 The Control class is the base class for all Visualize controls. More...
 
class  Coordinate
 The Coordinate class is a concept class that contains information about various coordinate spaces.
 
class  CubeMapDefinition
 The CubeMapDefinition class is a smart pointer to a database object. It is a handle to a cube map defined within a portfolio. More...
 
class  CubeMapDefinitionArray
 
class  CullingControl
 The HPS::CullingControl class is a smart pointer that is tied to a database object. Using this object, you are able to control the various options related to culling, such as enabling or disabling back face culling, vector culling, and frustum culling. This table lists default values for the various segment attributes accessible from HPS::CullingControl. More...
 
class  CullingKit
 The HPS::CullingKit class is a user space object, useful for carrying a group attribute settings. Calling HPS::CullingKit::GetDefault() will return a kit with values found in this table. More...
 
class  CurveAttributeControl
 The HPS::CurveAttributeControl class is a smart pointer that is tied to a database object. This object is used to manipulate the various attributes related to curved lines, such as budget, angle, deviation, and length. This table lists default values for the various segment attributes accessible from HPS::CurveAttributeControl. More...
 
class  CurveAttributeKit
 The HPS::CurveAttributeKit class is a user space object, useful for carrying a group attribute settings. Calling HPS::CurveAttributeKit::GetDefault() will return a kit with values found in this table. More...
 
class  CutGeometryGatheringOptionsKit
 
class  CuttingSection
 The CuttingSection class is a concept class for cutting-section-related enum classes.
 
class  CuttingSectionAttributeControl
 The HPS::CuttingSectionAttributeControl class is a smart pointer that is tied to a database object. This object is used to manipulate the various cutting section attributes. This table lists default values for the various segment attributes accessible from HPS::CuttingSectionAttributeControl. More...
 
class  CuttingSectionAttributeKit
 The HPS::CuttingSectionAttributeKit class is a user space object which encapsulates a set of attributes pertaining to cutting sections. Calling HPS::CuttingSectionAttributeKit::GetDefault() will return a kit with values found in this table. More...
 
class  CuttingSectionKey
 The CuttingSectionKey class is a smart pointer to a database object. It is a handle to a cutting section inserted via SegmentKey::InsertCuttingSection. More...
 
class  CuttingSectionKit
 The CuttingSectionKit class is a user space object. It is a kit analog to a CuttingSectionKey. More...
 
class  CuttingSectionOperator
 
class  Cylinder
 The Cylinder class is a concept class for cylinder-related enum classes.
 
class  CylinderAttributeControl
 The HPS::CylinderAttributeControl class is a smart pointer that is tied to a database object. This object is used to manipulate the various cylinder attributes, such as orientation and tessellation. This table lists default values for the various segment attributes accessible from HPS::CylinderAttributeControl. More...
 
class  CylinderAttributeKit
 The HPS::CylinderAttributeKit class is a user space object, useful for carrying a group attribute settings. Calling HPS::CylinderAttributeKit::GetDefault() will return a kit with values found in this table. More...
 
class  CylinderKey
 The CylinderKey class is a smart pointer to a database object. It is a handle to a cylinder inserted via SegmentKey::InsertCylinder. More...
 
class  CylinderKit
 The CylinderKit class is a user space object. It is a kit analog to a CylinderKey. More...
 
class  Database
 The Database class is a special type that is never intended to be instantiated. It contains static functions for creating top-level database objects as well as performing global queries and actions.
 
class  DebuggingControl
 The HPS::DebuggingControl class is a smart pointer that is tied to a database object. Using this control, you are able to set and show the resource monitor. This control is only accessible from a HPS::WindowKey. This table lists default values for the various segment attributes accessible from HPS::DebuggingControl. More...
 
class  DebuggingKit
 The HPS::DebuggingKit class is a user space object, useful for carrying a group attribute settings. Calling HPS::DebuggingKit::GetDefault() will return a kit with values found in this table. More...
 
class  Definition
 The Definition class is a smart pointer to a database object. It is the base class for all definition objects. More...
 
struct  DirectRGBColor
 
class  DistantLightKey
 The DistantLightKey class is a smart pointer to a database object. It is a handle to a distant light inserted via SegmentKey::InsertDistantLight. More...
 
class  DistantLightKit
 The DistantLightKit class is a user space object. It is a kit analog to a DistantLightKey. More...
 
class  DotGlyphElement
 The DotGlyphElement class is a user space object. It is used to dot elements to glyphs. More...
 
class  DoubleArray
 
class  DoubleMetadata
 The DoubleMetadata class is a smart pointer. It represents a piece of double Metadata. More...
 
struct  DPoint
 
class  Drawing
 
class  DrawingAttributeControl
 The HPS::DrawingAttributeControl class is a smart pointer that is tied to a database object. This object is used to manipulate various high-level settings, such as depth range, priority, and displacement. Note that some of the attributes available through this control should only be set for an entire window, while others can be set at multiple places. More...
 
class  DrawingAttributeKit
 The HPS::DrawingAttributeKit class is a user space object, useful for carrying a group attribute settings. Calling HPS::DrawingAttributeKit::GetDefault() will return a kit with values found in this table. More...
 
class  DrawWindowEvent
 The DrawWindowEvent class is the event generated when the driver draws the window background for each subwindow. More...
 
class  DriverEvent
 The DriverEvent class is the common base class of all driver events. A driver event represents a specific action the driver performs during an update. DriverEvents occur on the driver updater thread. More...
 
class  DriverEventHandler
 The DriverEventHandler class is the base class for driver event handlers. Custom driver event handlers should inherit from this. More...
 
class  DropDownListKitArray
 
struct  DVector
 
class  DVectorArray
 
class  Edge
 This is the Edge Class
 
class  EdgeAttributeControl
 The HPS::EdgeAttributeControl class is a smart pointer that is tied to a database object. Using this control, you can manipulate the various attributes associated with geometry edges. Edges are present on any piece of facetted geometry.This table lists default values for the various segment attributes accessible from HPS::EdgeAttributeControl. More...
 
class  EdgeAttributeKit
 The HPS::EdgeAttributeKit class is a user space object, useful for carrying a group attribute settings. Calling HPS::EdgeAttributeKit::GetDefault() will return a kit with values found in this table. More...
 
class  EllipseGlyphElement
 The EllipseGlyphElement class is a user space object. It is used to add ellipse elements to glyphs. More...
 
class  EllipseKey
 The EllipseKey class is a smart pointer to a database object. It is a handle to an ellipse inserted via SegmentKey::InsertEllipse. More...
 
class  EllipseKit
 The EllipseKit class is a user space object. It is the kit analog to an EllipseKey. More...
 
class  EllipticalArcKey
 The EllipticalArcKey class is a smart pointer to a database object. It is a handle to an elliptical arc inserted via SegmentKey::InsertEllipticalArc. More...
 
class  EllipticalArcKit
 The EllipticalArcKit class is a user space object. It is the kit analog to an EllipticalArcKey. More...
 
class  Emergency
 The Emergency class is a concept class for Emergency codes.
 
class  EmergencyHandler
 The EmergencyHandler class is the base class for an custom EmergencyHandler. An EmergencyHandler allows the developer to provide custom logic to handle 'emergency' situations. For example, one can set a soft memory limit using HPS::Database::SetSoftMemoryLimit. If that limit is hit, Visualize will call the EmergencyHandler.An EmergencyHandler is set by calling HPS::Database::SetEmergencyHandler. Only one EmergencyHandler can be set on the Database. If you try to set a second handler, the first one will be overwritten.The default emergency handler will print a few diagnostics to stdout (when run in debug mode), but will make no attempt to recover from the emergency condition. More...
 
class  ErrorEvent
 The ErrorEvent class is the event that will be generated if an asynchronous error occurs. More...
 
class  Event
 The Event class is the common base class of all events. An event can be an error, input event, or a custom event. Events occur asynchronously and are processed in order from an event queue. More...
 
class  EventDispatcher
 The EventDispatcher class is used for injecting any events and dealing with event handlers which handle those events. More...
 
class  EventHandler
 The EventHandler class is the base class for any event handler that can be created. All custom event handlers should inherit from this. More...
 
class  EventNotifier
 The EventNotifier class is a smart pointer that is tied to an event object. It is a special type of control that is used for synchronizing with an event's completion. More...
 
class  Exception
 
class  Exchange
 The Exchange class contains objects and enumerations used for importing and exporting CAD files via Exchange.
 
class  Factory
 The Factory class is used to create and query Sprocket objects. More...
 
class  FieldTypeArray
 
class  Filter
 The Filter class is a smart pointer. It represents a filter, i.e., a collection of visibility settings for a CADModel. More...
 
class  FilterActivationEvent
 
class  FilterArray
 
class  FinishPictureEvent
 The FinishPictureEvent class is the event generated when the driver finishes the update and puts the rendered image on screen (except for OffscreenWindows). More...
 
class  Float
 The Float class is a concept class that exposes a number of useful utilities for working with floating point numbers.
 
class  FloatArray
 
class  FlyOperator
 The FlyOperator class defines an operator which allows the user to accurately move the camera around the scene. This Operator works for both mouse- and touch-driven devices. Mouse-Driven Devices: W: Move camera position and target forward A: Pan camera left S: Move camera position and target forward D: Pan camera right C: Pan camera down Space: Pan camera up Q: Roll camera left E: Roll camera right Right-button down and move: Rotate camera in place Shift: Walk at double the speed while pressed Ctrl: Walk at half the speed while pressed Mouse Wheel: Increase / Decrease step length Shift + Mouse Wheel: Increase / Decrease field of view Touch-Driven Devices: touch -left side of screen: Pans camera in left or right, moves camera forward or back touch -right side of screen: Rotates camera in place Two-finger touch -right side of screen: Pans camera up or down, rolls camera left or right The movement speed increases as the user drags his fingers away from the initial touch position More...
 
class  FocusLostEvent
 The FocusLostEvent class is the event that is generated when an application loses focus More...
 
class  FontInfoState
 The FontInfoState class is a user space object, useful for carrying a group attribute settings. More...
 
class  FontSearchResults
 The FontSearchResults class is a smart-pointer to a database object. It contains the results of a Find operation. More...
 
class  FontSearchResultsIterator
 An iterator used for traversing results from a search on an associated FontSearchResults object. More...
 
class  GeometryKey
 
class  Glyph
 The Glyph class is a concept class for glyph-related enum classes.
 
class  GlyphDefinition
 The GlyphDefinition class is a smart pointer to a database object. It is a handler to a glyph defined within a portfolio. More...
 
class  GlyphDefinitionArray
 
class  GlyphElement
 The GlyphElement class is a user space object. It is the base class for all glyph elements. More...
 
class  GlyphElementArray
 
class  GlyphKit
 The GlyphKit class is a user space object. It is used when defining a glyph. More...
 
class  GlyphLinePatternElement
 The GlyphLinePatternElement class is a user space object. It is used for specifying glyphs elements within a line pattern. More...
 
struct  GlyphPoint
 
class  GlyphPointArray
 
class  Grid
 The Grid class is a concept class for grid-related enum classes.
 
class  GridKey
 The GridKey class is a smart pointer to a database object. It is a handle to a grid created by SegmentKey::InsertGrid. More...
 
class  GridKit
 The GridKit class is a user space object. It is a kit analog to a GridKey. More...
 
class  Hardcopy
 The Hardcopy class attempts to reproduce the scene graph to each of its supported export types. This includes printing to physical paper and 2D PDF.Default values for the various fields of the Hardcopy class can be found here.
 
class  HiddenLine
 
class  HiddenLineAttributeControl
 The HPS::HiddenLineAttributeControl class is a smart pointer that is tied to a database object. This control allows you to manipulate the various attributes associated with hidden lines. Hidden line is a rendering mode that applies to the scene as a whole. You should not set disparate hidden line attributes in your scene. This table lists default values for the various segment attributes accessible from HPS::HiddenLineAttributeControl. More...
 
class  HiddenLineAttributeKit
 The HPS::HiddenLineAttributeKit class is a user space object, useful for carrying a group attribute settings. Calling HPS::HiddenLineAttributeKit::GetDefault() will return a kit with values found in this table. More...
 
class  HighlightAreaOperator
 
class  HighlightControl
 The HPS::HighlightControl class is a smart pointer that is tied to a database object. It is used to control highlight and unhighlight operations on selection results, search results, key paths and keys. This table lists default * values for the various segment attributes accessible from HPS::HighlightControl. More...
 
class  HighlightEvent
 The HighlightEvent class is the event that will be triggered for each highlight or unhighlight call. More...
 
class  HighlightOperator
 
class  HighlightOptionsKit
 The HighlightOptionsKit class is a user space object. It is used to hold settings needed when performing a highlight or unhighlight. HPS::HighlightOptionsKit::GetDefault() will return a highlight options kit with values found in this table. More...
 
class  HPS_pinvoke
 
class  HPS_pinvoke_hps_sprk_exchange
 
class  HPS_pinvoke_hps_sprk_ops
 
class  HPS_pinvoke_hps_sprk_parasolid
 
class  HPS_pinvoke_hps_sprk_publish
 
class  HPS_pinvoke_hps_sprk_sketchup
 
class  HPS_pinvoke_sprk
 
class  Image
 The Image class contains objects for importing image files and enumerations used when defining images in Visualize.
 
class  ImageDefinition
 The ImageDefinition class is a smart pointer to a database object. It is a handle to an image defined within a portolfio. More...
 
class  ImageDefinitionArray
 
class  ImageKit
 The ImageKit class is a user space object. It is used for specifying all data associated with images. More...
 
class  ImageKitArray
 
class  ImportStatusEvent
 The ImportStatusEvent class is the event that can be used by importers to let the user know what they are currently working on More...
 
class  IncludeKey
 The IncludeKey class is a smart pointer to a database object. It is a handle to an include key created by SegmentKey::IncludeSegment. More...
 
class  IncludeKeyArray
 
class  IndexOutOfRangeException
 An IndexOutOfRangeException is thrown when a user tries to access an array element beyond the valid range, typically when interacting with the points or faces defining geometry. More...
 
class  InfiniteLine
 The InfiniteLine class is a concept class for infinite-line-related enum classes.
 
class  InfiniteLineGlyphElement
 The InfiniteLineGlyphElement class is a user space object. It is used to add infinite line and ray elements to a glyph. More...
 
class  InfiniteLineKey
 The InfiniteLineKey class is a smart pointer to a database object. It is a handle to an infinite line or ray inserted via SegmentKey::InsertInfiniteLine. More...
 
class  InfiniteLineKit
 The InfiniteLineKit class is a user space object. It is a kit analog to an InfiniteLineKey. More...
 
class  Info
 The Info class is a concept class for information, warning and error codes.
 
class  InformationEvent
 The InformationEvent class is the event that will be generated if an asynchronous informational message occurs. More...
 
struct  InnerPixelPoint
 
class  InnerPixelPointArray
 
struct  InnerWindowPoint
 
class  InnerWindowPointArray
 
class  InputEvent
 The InputEvent class is the base class for input events such as MouseEvent, TouchEvent, and KeyboardEvent. It contains functionality which is common to all input event types, namely the state of modifier keys. More...
 
class  IntArray
 
class  IntegerMetadata
 The IntegerMetadata class is a smart pointer. It represents a piece of integer Metadata. More...
 
class  InternalHPSArray< T >
 
class  InternalHPSBlittableArray< T >
 
class  InternalString
 
class  IntPtrArray
 
struct  IntRectangle
 
class  IntRectangleArray
 
class  InvalidLicenseException
 
class  InvalidObjectException
 
class  InvalidOperationException
 
class  InvalidSpecificationException
 
class  IOException
 The IOException class is an exception that is thrown if there was a problem during file import or export. More...
 
class  IONotifier
 The IONotifier 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. More...
 
class  Key
 The Key class is the common base class of all Visualize keys. Keys are handles to database objects and are the primary way of interacting with them (you would never modify a database object directly). The underlying mechanism is a smart pointer (assignment operator works like regular pointers). Attempting to use a deleted or otherwise invalid key will result in an InvalidObjectException. More...
 
class  KeyArray
 
class  KeyboardCodeArray
 
class  KeyboardEvent
 The KeyboardEvent class is the event generated for each key press and release. More...
 
class  KeyboardState
 The KeyboardState class represents the state of a keyboard for a particular event. More...
 
class  KeyHasher
 A std::hash compatible hasher for HPS::Key More...
 
class  KeyPath
 The KeyPath contains an array of keys, organized from leaf to root. It allows the user to perform a number of queries along that path including accumulating net attributes and converting coordinates. More...
 
class  KeyPathArray
 
class  Layout
 The Layout class is one of the four core display classes used in a Visualize application. It is meant to be used as part of a display hierarchy along with the Canvas, View, and Model objects. The parent of the Layout is the Canvas, and a Layout can have multiple Views. The Layout is meant to describe the way the Views are presented in the Canvas. Like the other three core objects, the Layout is backed by a HPS::SegmentKey. More...
 
class  LayoutArray
 
class  LayoutDeletedEvent
 
class  LayoutDetachedEvent
 
class  License
 
class  Lighting
 This is the Lighting Class
 
class  LightingAttributeControl
 The HPS::LightingAttributeControl class is a smart pointer that is tied to a database object. This control is used to set the lighting interpolation algorithm. This table lists default values for the various segment attributes accessible from HPS::LightingAttributeControl. More...
 
class  LightingAttributeKit
 The HPS::LightingAttributeKit class is a user space object, useful for carrying a group attribute settings. Calling HPS::LightingAttributeKit::GetDefault() will return a kit with values found in this table. More...
 
class  Line
 This is the Line Class
 
class  LineAttributeControl
 The HPS::LineAttributeControl class is a smart pointer that is tied to a database object. This control allows you to manipulate the weight and pattern of lines and polylines. This table lists default values for the various segment attributes accessible from HPS::LineAttributeControl. More...
 
class  LineAttributeKit
 The HPS::LineAttributeKit class is a user space object, useful for carrying a group of attribute settings related to lines. Calling HPS::LineAttributeKit::GetDefault() will return a kit with values found in this table. More...
 
class  LineGlyphElement
 The LineGlyphElement class is a user space object. More...
 
class  LineKey
 The LineKey class is a smart pointer to a database object. It is a handle to a line inserted via SegmentKey::InsertLine. More...
 
class  LineKit
 The LineKit class is a user space object. It is a kit analog to a LineKey. More...
 
class  LinePattern
 The LinePattern class is a concept class for line-pattern-related enum classes.
 
class  LinePatternDefinition
 The LinePatternDefinition class is a smart pointer to a database object. It is a handle to a line pattern defined within a portfolio. More...
 
class  LinePatternDefinitionArray
 
class  LinePatternElement
 The LinePatternElement class is a user space object. It is the base class for other line pattern element types. Line pattern elements are used to define a pattern that can be assigned lines or edges. More...
 
class  LinePatternElementArray
 
class  LinePatternKit
 The LinePatternKit class is a user space object. It is used when defining a line pattern. More...
 
class  LinePatternOptionsKit
 The LinePatternOptionsKit class is a user space object. It is used for specifying (or overriding) some line pattern options when setting a line pattern on a segment. More...
 
class  LinePatternParallelKit
 The LinePatternParallelKit class is a user space object. It is used to define a single parallel within a line pattern. More...
 
class  LinePatternParallelKitArray
 
class  LineSizeUnitsArray
 
class  LinkKitArray
 
class  ListBoxKitArray
 
class  Marker
 This is the Marker Class
 
class  MarkerAttributeControl
 The HPS::MarkerAttributeControl class is a smart pointer that is tied to a database object. This control allows you to manipulate the marker size and symbol at the segment level. This table lists default values for the various segment attributes accessible from HPS::MarkerAttributeControl. More...
 
class  MarkerAttributeKit
 The HPS::MarkerAttributeKit class is a user space object, useful for carrying a group attribute settings. Calling HPS::MarkerAttributeKit::GetDefault() will return a kit with values found in this table. More...
 
class  MarkerKey
 The MarkerKey class is a smart pointer to a database object. It is a handle to a marker inserted via SegmentKey::InsertMarker. More...
 
class  MarkerKit
 The MarkerKit class is a user space object. It is a kit analog to a MarkerKey. More...
 
class  Material
 The Material class is a concept class for material-related enum classes.
 
class  MaterialKit
 The MaterialKit class is a user space object, useful for carrying a group of attribute settings. A MaterialKit can be associated with various geometry or subgeometery types using a material mapping kit or control. More...
 
class  MaterialKitArray
 
class  MaterialMappingControl
 The HPS::MaterialMappingControl class is a smart pointer that is tied to a database object. This object allows you to manipulate materials at the segment level. Examples of materials include texture, color, and gloss, among other things. Materials can be applied to geometry faces, edges, vertices, and text. Light color can also be set using this control. Materials can be applied at the segment, entity, or subentity level. In all MaterialMappingControl functions that take an RGBAColor, the alpha channel is ignored.This table lists default values for the various segment attributes accessible from HPS::MaterialMappingControl. More...
 
class  MaterialMappingKit
 The HPS::MaterialMappingKit class is a user space object, used for grouping attribute settings related to materials. A HPS::MaterialMappingKit is assigned to a portfolio, which in turn associates the materials to various geometry or subgeometry. Calling HPS::MaterialMappingKit::GetDefault() will return a material mapping kit with values found in this table. More...
 
class  MaterialPaletteDefinition
 The MaterialPaletteDefinition class is a smart pointer to a database object. It is a handle to a material palette defined within a portfolio. More...
 
class  MaterialPaletteDefinitionArray
 
class  MaterialTypeArray
 
class  MatrixKit
 The MatrixKit class is a user space object, useful for carrying a group attribute settings. More...
 
class  Mesh
 The Mesh class is a concept class for mesh-related enum classes.
 
class  MeshKey
 The MeshKey class is a smart pointer to a database object. It is a handle to a mesh created by SegmentKey::InsertMesh. More...
 
class  MeshKit
 The MeshKit class is a user space object. It is a kit analog to a MeshKey. More...
 
class  Metadata
 The Metadata class is a smart pointer. It represents a variety of metadata, i.e., a (name, value) pair, which might be associated with a Component, e.g., IDs, names, layers, user-defined or format-specific attributes, etc. More...
 
class  MetadataArray
 
class  Model
 The Model class is one of the four core display classes used in a Visualize application. It is meant to be used as part of a display hierarchy along with the Canvas, Layout, and View objects. The parent of the Model is the View. The Model is meant to represent a segment which contains a geometric model. Like the other three core objects, the Model is backed by a HPS::SegmentKey. More...
 
class  ModelArray
 
class  ModelDeletedEvent
 
class  ModelDetachedEvent
 
class  ModellingMatrixControl
 The ModellingMatrixControl class is a smart pointer that is tied to a database object. This control gives you access to a segment's modelling matrix. You can set an entire matrix or individual elements. Additionally, this class provides a small set of utility methods for all the basic transformations, as well as getting the matrix adjoint and determinant. Elements of modelling matrices are in row-major order. More...
 
struct  ModifierKeys
 
struct  MouseButtons
 
class  MouseEvent
 The MouseEvent class is the event generated for each mouse action. More...
 
class  MouseState
 The MouseState class represents the state of the mouse or similar pointer device for a particular event. More...
 
class  MouseWheelOperator
 
class  NamedStyleDefinition
 The NamedStyleDefinition class is a smart pointer to a database object. It is a handle to a named style defined within a portfolio. More...
 
class  NamedStyleDefinitionArray
 
class  NavigationCubeControl
 The navigationCubeControl allows you to turn on or off the navigation cube, move it to a specific corner of the screen, change the material palette used to style it, or otherwise manipulate it. More...
 
class  NavigationCubeOperator
 The NavigationCubeOperator class defines an operator which allows the user to interact with the navigation cube. This Operator works for both mouse- and touch-driven devices. Mouse-Driver Devices: Left Button Down: Snap view to plane Left Button Down and Move: Rotates the scene Touch-Driven Devices: Tap: Snaps view to plane Tap and Move: Rotates the scene More...
 
struct  NormalizedPoint
 
class  NormalizedPointArray
 
class  NURBSCurveKey
 The NURBSCurveKey class is a smart pointer to a database object. It is a handle to a NURBS curve inserted via SegmentKey::InsertNURBSCurve. More...
 
class  NURBSCurveKit
 The NURBSCurveKit class is a user space object. It is a kit analog to a NURBSCurveKey. More...
 
class  NURBSSurfaceAttributeControl
 The HPS::NURBSSurfaceAttributeControl class is a smart pointer that is tied to a database object. This object allows you to manipulate various settings related to NURBS surfaces, such as budget, angle, deviation, and width. This table lists default values for the various segment attributes accessible from HPS::NURBSSurfaceAttributeControl. More...
 
class  NURBSSurfaceAttributeKit
 The HPS::NURBSSurfaceAttributeKit class is a user space object that contains settings related to NURBS surfaces. Calling HPS::NURBSSurfaceAttributeKit::GetDefault() will return a kit with values found in this table. More...
 
class  NURBSSurfaceKey
 The NURBSSurfaceKey class is a smart pointer to a database object. It is a handle to a NURBS surface inserted via SegmentKey::InsertNURBSSurface. More...
 
class  NURBSSurfaceKit
 The NURBSSurfaceKit class is a user space object. It is a kit analog to a NURBSSurfaceKey. More...
 
class  OBJ
 The OBJ class contains objects and enumerations used for importing OBJ files.
 
class  Object
 The Object class is the common base class of most Visualize classes. More...
 
struct  ObjectPoint
 
class  ObjectPointArray
 
class  OffScreenWindowKey
 The OffScreenWindowKey class is a smart pointer to a database object. Offscreen windows are special types of windows that represent images that can be rendered into. More...
 
class  OffScreenWindowOptionsControl
 The HPS::OffScreenWindowOptionsControl class is a smart pointer that is tied to a database object. It is used to query offscreen-window-specific options on an OffScreenWindowKey. This control also gives you the ability to make a screenshot of the Visualize scene using ShowImage. This table lists default values for the various segment attributes accessible from HPS::OffScreenWindowOptionsControl. More...
 
class  OffScreenWindowOptionsKit
 The HPS::OffScreenWindowOptionsKit class is a user space object. It is used to specify off-screen-window-specific options. Calling HPS::OffScreenWindowOptionsKit::GetDefault() will return an options kit with values found in this table. More...
 
class  Operator
 The Operator class is the base class for classes which handle under input and operate on the scene. This class handles GUI events such as key presses, mouse movement and clicks, and touches More...
 
class  OperatorControl
 The OperatorControl class is a smart pointer that is tied to a database object. This control allows you to add, remove, or otherwise manipulate operators associated with a view. More...
 
class  OperatorPtrArray
 
class  OrbitOperator
 The OrbitOperator class defines an operator which allows the user to orbit the camera. This Operator works for both mouse- and touch-driven devices. Mouse-Driven Devices: Left button pressed and move: Orbit camera Touch-Driven Devices: Touch down and move: Orbit camera More...
 
class  PageKitArray
 
class  PanOperator
 The PanOperator class defines an operator which allows the user to pan the camera. This Operator works for both mouse- and touch-driven devices. Mouse-Driven Devices: Left button pressed and move: Pan camera Touch-Driven Devices: Touch down and move: Pan camera More...
 
class  PanOrbitZoomOperator
 The PanOrbitZoomOperator class defines an operator which allows the user to pan, orbit and zoom the camera. This Operator works for both mouse- and touch-driven devices. Mouse-Driven Devices: Left button pressed and move: Orbit camera Left button pressed and move + Shift: Pan camera Left button pressed and move + Ctrl: Zoom camera Touch-Driven Devices: Touch down and move: Orbit camera Two finger touch and move: Pan camera Pinch: Zoom camera More...
 
class  Parasolid
 The Parasolid class contains objects and enumerations used for importing and exporting CAD files via Parasolid.
 
class  ParasolidEntityArray
 
class  Performance
 
class  PerformanceControl
 The HPS::PerformanceControl class is a smart pointer that is tied to a database object. This object is used to enable and disable performance-related attributes, such as display lists and static model. This table lists default values for the various segment attributes accessible from HPS::PerformanceControl. More...
 
class  PerformanceKit
 The HPS::PerformanceKit class is a user space object, useful for carrying a group of attribute settings related to performance settings. Calling HPS::PerformanceKit::GetDefault() will return a kit with values found in this table. More...
 
class  PermissionTypeArray
 
struct  PixelPoint
 
class  PixelPointArray
 
struct  Plane
 
struct  Plane2D
 
class  PlaneArray
 
struct  Point
 
struct  Point2D
 
class  PointArray
 
class  PointArrayArray
 
class  PolygonKey
 The PolygonKey class is a smart pointer to a database object. It is a handle to a polygon created by SegmentKey::InsertPolygon. More...
 
class  PolygonKit
 The PolygonKit class is a user space object. It is a kit analog to a PolygonKey. More...
 
class  PortfolioControl
 The PortfolioControl class is a smart pointer that is tied to a database object. Controls are used for manipulating settings within the database. More...
 
class  PortfolioKey
 The PortfolioKey class is a smart pointer to a database object. Portfolios are special objects that can only contain definitions. A segment can use a portfolio to gain access to the definitions it contains. More...
 
class  PortfolioKeyArray
 
class  PostProcessEffects
 
class  PostProcessEffectsControl
 The HPS::PostProcessEffectsControl class is a smart pointer that is tied to a database object. This object is effective only for the shader-based driver interfaces such as DirectX and OpenGL2. Ambient occlusion, bloom, silhouette edges, and depth of field are all enabled through this control. Default values for the various fields of HPS::PostProcessEffectsControl can be found here. More...
 
class  PostProcessEffectsKit
 The HPS::PostProcessEffectsKit class is a user space object, useful for carrying a group of attribute settings related to post-process effects. Calling HPS::PostProcessEffectsKit::GetDefault() will return a kit with values found in this table. More...
 
class  Publish
 The Publish class contains objects and enumerations used for exporting 3D PDF files via Publish.
 
class  Quaternion
 
class  RadioButtonKitArray
 
struct  Rectangle
 
class  ReferenceKey
 The ReferenceKey class is a smart pointer to a database object. It is a handle to a geometry reference returned by SegmentKey::ReferenceGeometry. More...
 
class  ReferenceKeyArray
 
class  RelativeOrbitOperator
 
class  Rendering
 
struct  RGB24Color
 
struct  RGBA32Color
 
struct  RGBAColor
 
class  RGBAColorArray
 
struct  RGBAS32Color
 
struct  RGBColor
 
class  RGBColorArray
 
class  SceneTree
 The SceneTree 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 scene graph or segment browser. More...
 
class  SceneTreeItem
 The SceneTreeItem 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 scene graph or segment browser. More...
 
struct  ScreenRangePoint
 
class  ScreenRangePointArray
 
class  Search
 The Search class is a concept class for search-related enum classes.
 
class  SearchOptionsKit
 The SearchOptionsKit class is a user space object. It contains options used when performing a search. More...
 
class  SearchResults
 The SearchResults class is a smart-pointer to a database object. It contains the results of a Find operation. More...
 
class  SearchResultsIterator
 An iterator used for traversing results from a search on an associated SearchResults object. More...
 
class  SearchTypeArray
 
class  SegmentKey
 The SegmentKey class is a smart pointer to a database object. Segments are the nodes in the scene graph. They can contain attributes, geometry, or other segments, among other things. More...
 
class  SegmentKeyArray
 
class  SegmentOptimizationOptions
 
class  SegmentOptimizationOptionsKit
 Configuration options kit for controlling HPS::Segment::Optimize behavior. More...
 
class  Selectability
 This is the Selectability Class
 
class  SelectabilityControl
 The SelectabilityControl class is a smart pointer that is tied to a database object. This object allows you to set and unset the selectability of the various types of geometry, such as faces, lines, markers, and vertices.Default values for the various fields of SelectabilityControl can be found here. More...
 
class  SelectabilityKit
 The HPS::SelectabilityKit class is a user space object, useful for carrying a group attribute settings. Calling HPS::SelectabilityKit::GetDefault() will return a kit with values found in this table. More...
 
class  SelectAreaOperator
 The HPS::SelectAreaOperator class is a selection mechanism that operates on a rectangle input. As with all operators, this operator must be made active on a HPS::View object before it can be used. The results of the last selection can be obtained by calling GetActiveSelection(). Selection options such as granularity, algorithm, proximity, and more are set using a HPS::SelectionOptionsKit passed to SetSelectionOptions. See Programming Guide section "User Interaction" for more details on how to use operators. More...
 
class  Selection
 The Selection class is a concept class for selection-related enum classes.
 
class  SelectionControl
 The SelectionControl class is a smart pointer that is tied to a database object. It is used to perform both window space selections (by point, by area, by polygon, by line) and object space selections (by shell, by volume, by ray). More...
 
class  SelectionItem
 The SelectionItem class is a smart-pointer to a database object. It represents an item in a SelectionResults object. More...
 
class  SelectionOptionsControl
 The HPS::SelectionOptionsControl class is a smart pointer that is tied to a database object. It is used to set selection related options on a HPS::WindowKey. Options include the selection algorithm, granularity, internal limit, related limit, level, proximity, and sorting. Default values for the various fields of HPS::SelectionOptionsControl can be found here. More...
 
class  SelectionOptionsKit
 The SelectionOptionsKit class is a user space object. It contains options related to selection. Default values for the SelectionOptionsKit can be found in this table. More...
 
class  SelectionResults
 The SelectionResults class is a smart pointer to a database object. It is a handle to the results of a selection action and allows iteration over them. When there are no remaining handles to a given selection result, the memory associated with it is freed. More...
 
class  SelectionResultsIterator
 The SelectionResultsIterator class is used to iterate over a SelectionResults object and access the SelectionItem objects contained within it. More...
 
class  SelectOperator
 The HPS::SelectOperator class is a selection mechanism that is intended to operate on a single selection point. As with all operators, this operator must be made active on a HPS::View object before it can be used. The results of the last selection can be obtained by calling GetActiveSelection(). Selection options such as granularity, algorithm, proximity, and more are set using a HPS::SelectionOptionsKit passed to SetSelectionOptions. See Programming Guide section "User Interaction" for more details on how to use operators. More...
 
class  Shader
 The Shader class contains objects for importing shader source files and enumerations used when defining shaders in Visualize.
 
class  ShaderDefinition
 The ShaderDefinition class is a smart pointer to a database object. It is a handle to a shader defined within a portfolio. More...
 
class  ShaderDefinitionArray
 
class  ShaderKit
 The ShaderKit class is a user space object. It is used for specifying all settings related to a ShaderDefinition. More...
 
class  SheetArray
 
class  Shell
 The Shell class is a concept class for shell-related enum classes.
 
class  ShellKey
 The ShellKey class is a smart pointer to a database object. It is a handle to a shell created by SegmentKey::InsertShell. More...
 
class  ShellKit
 The ShellKit class is a user space object. It is the kit analog to a ShellKey. More...
 
class  ShellOptimizationOptionsKit
 The ShellOptimizationOptionsKit class is a user space object. It is used for setting options for a shell optimization operation. Calling HPS::ShellOptimizationOptionsKit::GetDefault() will return an options kit with values found in this table. More...
 
class  ShellRelationArray
 
class  ShellRelationOptionsKit
 The HPS::ShellRelationOptionsKit class is a user space object. It is used for setting options for a shell relation operation. Calling HPS::ShellRelationOptionsKit::GetDefault() will return an options kit with values found in this table. More...
 
class  ShellRelationResultsKit
 The ShellKit class is a user space object. It contains results from a shell relation operation. More...
 
class  SignatureFieldKitArray
 
struct  SimpleCuboid
 
struct  SimpleSphere
 
class  SimpleWalkOperator
 The SimpleWalkOperator class defines an operator which allows the user to move forward and backwards and rotate while staying snapped to a plane. This Operator works for both mouse-driven devices only. Mouse-Driven Devices: Left-mouse button down and move: Pans the camera forward and backward, or rotates the scene based on the movement direction. The mouse sensitivity changes based on how far the mouse is dragged from the starting point Shift + Mouse Wheel: Increases / Decreases field of view More...
 
class  SizeTArray
 
class  Sketchup
 The Sketchup class contains objects used for importing SketchUp files.
 
class  SlideTableKitArray
 
class  SmoothTransitionCompleteEvent
 The SmoothTransitionCompleteEvent class is the event that will be triggered when a Smooth Transition ends. More...
 
class  SolidLinePatternElement
 The SolidLinePatternElement class is a user space object. It is used for specifying solid elements within a line pattern. More...
 
class  SourceTypeArray
 
class  Sphere
 This is the Sphere Class
 
class  SphereAttributeControl
 The HPS::SphereAttributeControl class is a smart pointer that is tied to a database object. This control gives you access to the tessellation value for spheres. This table lists default values for the various segment attributes accessible from HPS::SphereAttributeControl. More...
 
class  SphereAttributeKit
 The HPS::SphereAttributeKit class is a user space object, useful for carrying a group attribute settings. Calling HPS::SphereAttributeKit::GetDefault() will return a kit with values found in this table. More...
 
class  SphereKey
 The SphereKey class is a smart pointer to a database object. It is a handle to a sphere inserted via SegmentKey::InsertSphere. More...
 
class  SphereKit
 The SphereKit class is a user space object. It is a kit analog to a SphereKey. More...
 
class  Spotlight
 The Spotlight class is a concept class for spotlight-related enum classes.
 
class  SpotlightKey
 The SpotlightKey class is a smart pointer to a database object. It is a handle to a spotlight inserted via SegmentKey::InsertSpotlight. More...
 
class  SpotlightKit
 The HPS::SpotlightKit class is a user space object. It is the kit counterpart to a HPS::SpotlightKey. Calling HPS::SpotlightKit::GetDefault() will return a kit with values found in this table. More...
 
class  SprkKeyArray
 
class  Sprocket
 
class  SprocketControl
 
class  SprocketPath
 The SprocketPath class is a utility class which can be used to automatically obtain a KeyPath from the Model to the Canvas. More...
 
class  StandAloneWindowEvent
 The StandAloneWindowEvent class is the event that is generated by a Standalone window. More...
 
class  StandAloneWindowKey
 The StandAloneWindowKey object is a handle to a stand-alone window that Visualize can draw into. Standalone windows are always directly created by Visualize. The Visualize rendering context will use the entire window for rendering. Standalone windows are only supported on Microsoft Windows and Linux platforms. More...
 
class  StandAloneWindowOptionsControl
 The HPS::StandAloneWindowOptionsControl class is a smart pointer that is tied to a database object. It is used to set and query stand-alone-window-specific options on a HPS::StandAloneWindowKey. Default values for the various fields of HPS::StandAloneWindowOptionsControl can be found here. More...
 
class  StandAloneWindowOptionsKit
 The StandAloneWindowOptionsKit class is a user space object. It is used to specify stand-alone-window-specific options Calling HPS::StandAloneWindowOptionsKit::GetDefault() will return an options kit with values found in this table. More...
 
class  STL
 The STL class contains objects and enumerations used for importing STL files.
 
class  Stream
 The Stream class contains objects and enumerations used for importing and exporting HSF files.
 
class  StringMetadata
 The StringMetadata class is a smart pointer. It represents a piece of string Metadata. More...
 
class  Style
 This is the Style Class
 
class  StyleControl
 The StyleControl class is a smart pointer that is tied to a database object. Controls are used for manipulating settings within the database. More...
 
class  StyleKey
 The StyleKey class is a smart pointer to a database object. It is a handle to a style key created by StyleControl::PushSegment. More...
 
class  StyleKeyArray
 
class  StyleTypeArray
 
class  Subwindow
 This is the Subwindow Class
 
class  SubwindowControl
 The HPS::SubwindowControl class is a smart pointer that is tied to a database object. The HPS::SubwindowControl allows you to manipulate the various settings associated with subwindows, such as border, background, and priority. As the main Visualize window is also an implicit subwindow, this control also allows you to set the rendering algorithm. The rendering algorithm should only have a single setting for each window or subwindow. Setting disparate rendering algorithms in multiple places in your scene can lead to unexpected results. Default values for the various fields of HPS::SubwindowControl can be found here. More...
 
class  SubwindowKit
 The HPS::SubwindowKit class is a user space object, useful for carrying a group of attribute settings related to subwindows. Calling HPS::SubwindowKit::GetDefault() will return a kit with values found in this table. More...
 
class  TableKitArray
 
class  Text
 The Text class is a concept class for text-related enum classes.
 
class  TextAttributeControl
 The HPS::TextAttributeControl class is a smart pointer that is tied to a database object. This object gives you access to all the attributes associated with text, such as font, size, and rotation. Text characteristics such as bold, italic, and underline are also accessed through the HPS::TextAttributeControl. Default values for the various fields of HPS::TextAttributeControl can be found here. More...
 
class  TextAttributeKit
 The HPS::TextAttributeKit class is a user space object, useful for carrying a group attribute settings. Calling HPS::TextAttributeKit::GetDefault() will return a kit with values found in this table. More...
 
class  TextFieldKitArray
 
class  TextKey
 The TextKey class is a smart pointer to a database object. It is a handle to text inserted via SegmentKey::InsertText. More...
 
class  TextKit
 The TextKit class is a user space object. It is the kit analog to a TextKey. More...
 
class  TextKitArray
 
class  TextureDefinition
 The TextureDefinition class is a smart pointer to a database object. It is a handler to a texture defined within a portfolio. More...
 
class  TextureDefinitionArray
 
class  TextureMatrixControl
 The TextureMatrixControl class is a smart pointer that is tied to a database object. It controls the various attributes related to texture matrices. More...
 
class  TextureOptionsKit
 The TextureOptionsKit class is a user space object. It is used for setting texture options when defining textures or cube maps. Calling HPS::TextureOptionsKit::GetDefault() will return an options kit with values found in this table. More...
 
class  TimeMetadata
 The TimeMetadata class is a smart pointer. It represents a piece of time Metadata, i.e., a 32-bit integer to be interpreted as time_t. More...
 
class  TimerTickEvent
 The TimerTickEvent class is the event that will be triggered for each timer tick. More...
 
class  ToleranceArray
 
struct  Touch
 
class  TouchArray
 
class  TouchEvent
 The TouchEvent class is the event generated for each touch action on a multi-touch device. More...
 
class  TouchState
 The TouchState class represents the state of touches on a multi-touch device for a particular event. More...
 
class  TransformMaskControl
 The HPS::TransformMaskControl class is a smart pointer that is tied to a database object. This class allows you to manipulate the settings associated with a transform mask. A transform mask allows a segment to ignore its inherited transform. For example, if you want to be able to rotate a scene at a high level, but have a piece of geometry ignore rotations, you could achieve that effect using a transform mask. This table lists default values for the various segment attributes accessible from HPS::TransformMaskControl. More...
 
class  TransformMaskKit
 The HPS::TransformMaskKit class is a user space object, useful for carrying a group attribute settings. Calling HPS::TransformMaskKit::GetDefault() will return a kit with values found in this table. More...
 
class  Transparency
 This is the Transparency Class
 
class  TransparencyControl
 The HPS::TransparencyControl class is a smart pointer that is tied to a database object. This object allows you to set and unset the algorithms used for calculating transparency. Some algorithms, such as depth peeling, have additional attributes, and those are also controlled using this class. Default values for the various fields of HPS::TransparencyControl can be found here. More...
 
class  TransparencyKit
 The HPS::TransparencyKit class is a user space object, useful for carrying a group of attribute settings related to transparency. Calling HPS::TransparencyKit::GetDefault() will return a kit with values found in this table. More...
 
class  TreeContext
 The TreeContext class is a user space object. It contains a spatial partition used for selection and relation computations with shells. If many world-space selections are going to be computed without modifying the segment tree, using the same tree context for all of them can be a significant optimization. If one is not specified, a new one is computed internally each time. More...
 
class  Trim
 The Trim class is a concept class for trim-related enum classes.
 
class  TrimElement
 The TrimElement class is a user space object. It is used to specify the curves that are used to define a trim region. More...
 
class  TrimElementArray
 
class  TrimKit
 The TrimKit class is a user space object. It is used to define trim curves (either NURBS curves or lines) that can be used to trim NURBS surfaces. More...
 
class  TrimKitArray
 
class  TurntableOperator
 The TurntableOperator class defines an operator which allows the user to orbit the camera along a specific axis. This Operator works for both mouse- and touch-driven devices. Mouse-Driven Devices: Left button pressed and move: Orbit camera around z-axis Mouse wheel: Orbit camera around y-axis Left click + Control: Selects click location as rotation center Touch-Driven Devices: Touch down and move: Orbit camera around z-axis Two finger touch and move: Orbit camera around y-axis Double Tap: Selects click location as rotation center More...
 
class  UnsignedIntArray
 
class  UnsignedIntegerMetadata
 The UnsignedIntegerMetadata class is a smart pointer. It represents a piece of unsigned integer Metadata. More...
 
class  UpdateCompletedEvent
 The UpdateCompletedEvent class is the event that is generated when an update is completed More...
 
struct  UpdateInfo
 
class  UpdateNotifier
 The UpdateNotifier class is a smart pointer that is tied to a window update. It is a special type of control that is used for synchronizing with an window update status. More...
 
class  UpdateOptionsControl
 The HPS::UpdateOptionsControl class is a smart pointer that is tied to a database object. It is used to set selection related options on a HPS::WindowKey. Options include the selection algorithm, granularity, internal limit, related limit, level, proximity, and sorting. Default values for the various fields of HPS::UpdateOptionsControl can be found here. More...
 
class  UpdateOptionsKit
 The HPS::UpdateOptionsKit class is a user space object. It contains options related to selection. Calling HPS::UpdateOptionsKit::GetDefault() will return a kit with values found in this table. More...
 
class  UTF8Array
 
class  UTF8Hasher
 A std::hash compatible hasher for HPS::UTF8 More...
 
struct  Vector
 
struct  Vector2D
 
class  VectorArray
 
class  View
 The View class is one of the four core display classes used in a Visualize application. It is meant to be used as part of a display hierarchy along with the Canvas, Layout, and Model objects. The View has a parent Layout and can contain a single Model. The View is meant to represent one particular camera's view of the scene. Like the other three core objects, the View is backed by a HPS::SegmentKey. More...
 
class  ViewArray
 
class  ViewDeletedEvent
 
class  ViewDetachedEvent
 
class  ViewKitArray
 
class  ViewportArray
 
class  VisibilityControl
 The HPS::VisibilityControl class is a smart pointer that is tied to a database object. This control allows you to set and unset the visibility of any type of geometry or subentity in the scene. The visibility of windows is also controlled here. Additionally, various behaviors such as casting and emitting shadows is also done through this control. Default values for the various fields of HPS::VisibilityControl can be found here. More...
 
class  VisibilityKit
 The HPS::VisibilityKit class is a user space object, useful for carrying a group of attribute settings. Calling HPS::VisibilityKit::GetDefault() will return a kit with values found in this table. More...
 
class  VisualEffectsControl
 The HPS::VisualEffectsControl class is a smart pointer that is tied to a database object. This object enables you to set and unset various visual effects, such as shadows (including shadow color), reflection planes, and anti-aliasing. Default values for the various fields of HPS::VisualEffectsControl can be found here. More...
 
class  VisualEffectsKit
 The HPS::VisualEffectsKit class is a user space object, useful for carrying a group attribute settings. Calling HPS::VisualEffectsKit::GetDefault() will return a kit with values found in this table. More...
 
class  WalkOperator
 The WalkOperator class defines an operator which allows the user to accurately move the camera around the scene, while snapped to a plane. This operator works for both mouse and touch-driven devices. More...
 
class  WarningEvent
 The WarningEvent class is the event that will be generated if an asynchronous warning occurs. More...
 
class  Window
 The Window class is a concept class for window-related enum classes.
 
class  WindowInfoControl
 The WindowInfoControl class is a smart pointer that is tied to a database object. This object allows you to query various attributes about a window, such as its size and aspect ratio. More...
 
class  WindowInfoKit
 The WindowInfoKit class is a user space object, useful for carrying a group attribute settings. More...
 
class  WindowKey
 The WindowKey class is a smart pointer to a database object. Windows are special segments that are backed by a driver instance and a physical window. Some operations and attributes can only be performed or set from window keys. The WindowKey class itself is a base class for more specific window types (application windows, off-screen windows, stand-alone windows). More...
 
class  WindowKeyArray
 
struct  WindowPoint
 
class  WindowPointArray
 
class  World
 The World class is a special object that must be constructed prior to making any database calls and must exist for the life of the application. More...
 
struct  WorldPoint
 
class  WorldPointArray
 
class  ZoomBoxOperator
 
class  ZoomFitTouchOperator
 The ZoomFitTouchOperator class defines an operator which fits the camera to the model currently loaded. This Operator works for touch-driven devices only. Touch-Driven Devices: Double Tap: Fits the camera to the model currently loaded. More...
 
class  ZoomOperator
 The ZoomOperator class defines an operator which allows the user to zoom the camera. This Operator works for both mouse- and touch-driven devices. Mouse-Driven Devices: Left button pressed and move: Zoom camera Touch-Driven Devices: Pinch: Zoom camera More...
 

Enumerations

enum  IOResult {
  Success = 0, Failure = 1, FileNotFound = 2, UnableToOpenFile = 3,
  InvalidOptions = 4, InvalidSegment = 5, InProgress = 6, Canceled = 7,
  UnableToLoadLibraries = 8, VersionIncompatibility = 9, InitializationFailed = 10, UnsupportedFormat = 11
}
 
enum  Type : uint {
  None = 0x00000000, GenericMask = 0xFFFFFF00, World = 0x00000001, UTF8 = 0x00000002,
  EventDispatcher = 0x00000003, EventHandler = 0x00000004, EventNotifier = 0x00000005, UpdateNotifier = 0x00000006,
  SearchResults = 0x00000008, FontSearchResults = 0x00000009, SearchResultsIterator = 0x0100000A, FontSearchResultsIterator = 0x0100000B,
  SelectionResults = 0x0000000C, SelectionResultsIterator = 0x0100000D, SelectionItem = 0x0000000E, TreeContext = 0x0000000F,
  StreamToolkit = 0x00000010, DriverEventHandler = 0x00000011, IONotifier = 0x04000100, StreamImportNotifier = 0x04000101,
  STLImportNotifier = 0x04000102, OBJImportNotifier = 0x04000103, ExchangeImportNotifier = 0x04000104, SketchupImportNotifier = 0x04000105,
  ParasolidImportNotifier = 0x04000106, ExchangeTranslationNotifier = 0x04000107, ExchangeExportNotifier = 0x04000108, StreamExportNotifier = 0x04000109,
  ExchangeReloadNotifier = 0x0400010A, Kit = 0x01000000, MarkerKit = 0x01000010, SphereAttributeKit = 0x01000011,
  TextAttributeKit = 0x01000012, TransparencyKit = 0x01000013, VisibilityKit = 0x01000014, VisualEffectsKit = 0x01000015,
  CuttingSectionAttributeKit = 0x01000016, CircleKit = 0x01000017, CircularArcKit = 0x01000018, CircularWedgeKit = 0x01000019,
  CuttingSectionKit = 0x0100001A, CylinderKit = 0x0100001B, DistantLightKit = 0x0100001C, EllipseKit = 0x0100001D,
  EllipticalArcKit = 0x0100001E, InfiniteLineKit = 0x0100001F, LineKit = 0x01000020, NURBSCurveKit = 0x01000021,
  MeshKit = 0x01000022, NURBSSurfaceKit = 0x01000023, PolygonKit = 0x01000024, SphereKit = 0x01000025,
  SpotlightKit = 0x01000026, ShellKit = 0x01000027, TextKit = 0x01000028, MaterialKit = 0x01000029,
  TrimKit = 0x0100002A, TextureOptionsKit = 0x0100002C, LinePatternKit = 0x0100002D, GlyphKit = 0x0100002E,
  ImageKit = 0x0100002F, LinePatternOptionsKit = 0x01000030, CameraKit = 0x01000031, BoundingKit = 0x01000032,
  CullingKit = 0x01000033, CurveAttributeKit = 0x01000034, CylinderAttributeKit = 0x01000035, EdgeAttributeKit = 0x01000036,
  LightingAttributeKit = 0x01000037, LineAttributeKit = 0x01000038, MarkerAttributeKit = 0x01000039, MaterialMappingKit = 0x0100003A,
  MatrixKit = 0x0100003B, NURBSSurfaceAttributeKit = 0x0100003C, PostProcessEffectsKit = 0x0100003D, SelectabilityKit = 0x0100003E,
  SelectionOptionsKit = 0x0100003F, StandAloneWindowOptionsKit = 0x01000040, OffScreenWindowOptionsKit = 0x01000041, ApplicationWindowOptionsKit = 0x01000042,
  HighlightOptionsKit = 0x01000043, LinePatternParallelKit = 0x01000044, SubwindowKit = 0x01000045, PerformanceKit = 0x01000046,
  HiddenLineAttributeKit = 0x01000047, DrawingAttributeKit = 0x01000048, ShaderKit = 0x01000049, DebuggingKit = 0x0100004A,
  ContourLineKit = 0x0100004B, StreamImportOptionsKit = 0x0100004C, StreamImportResultsKit = 0x0100004D, StreamExportOptionsKit = 0x0100004E,
  StreamExportResultsKit = 0x0100004F, WindowInfoKit = 0x01000050, ImageImportOptionsKit = 0x01000051, SearchOptionsKit = 0x01000052,
  ShaderImportOptionsKit = 0x01000053, HardcopyExportOptionsKit = 0x01000055, AttributeLockKit = 0x01000056, TransformMaskKit = 0x01000057,
  ColorInterpolationKit = 0x01000058, UpdateOptionsKit = 0x01000059, ImageExportOptionsKit = 0x0100005A, OBJImportOptionsKit = 0x0100005B,
  OBJImportResultsKit = 0x0100005C, STLImportOptionsKit = 0x0100005D, STLImportResultsKit = 0x0100005E, ShellOptimizationOptionsKit = 0x0100005F,
  ShellRelationOptionsKit = 0x01000060, ShellRelationResultsKit = 0x01000061, GridKit = 0x01000062, CutGeometryGatheringOptionsKit = 0x01000063,
  SegmentOptimizationOptionsKit = 0x01000064, LinePatternElement = 0x03000000, SolidLinePatternElement = 0x03000001, BlankLinePatternElement = 0x03000002,
  GlyphLinePatternElement = 0x03000003, GlyphElement = 0x05000000, DotGlyphElement = 0x05000001, LineGlyphElement = 0x05000002,
  EllipseGlyphElement = 0x05000003, CircularArcGlyphElement = 0x05000004, InfiniteLineGlyphElement = 0x05000005, TrimElement = 0x07000000,
  Condition = 0x09000000, NOTCondition = 0x09000001, ANDCondition = 0x09000002, ORCondition = 0x09000003,
  XORCondition = 0x09000004, EQCondition = 0x09000005, NEQCondition = 0x09000006, GTCondition = 0x09000007,
  LTCondition = 0x09000008, GTEQCondition = 0x09000009, LTEQCondition = 0x0900000A, MouseState = 0x01001001,
  TouchState = 0x01001002, KeyboardState = 0x01001003, FontInfoState = 0x01001004, KeyPath = 0x01000F01,
  Key = 0x10000000, IncludeKey = 0x10000001, PortfolioKey = 0x10000002, StyleKey = 0x10000003,
  SegmentKey = 0x10200000, WindowKey = 0x10600000, StandAloneWindowKey = 0x10600001, OffScreenWindowKey = 0x10600002,
  ApplicationWindowKey = 0x10600003, GeometryKey = 0x10100000, ReferenceKey = 0x10100001, CircleKey = 0x10100002,
  CircularArcKey = 0x10100003, CircularWedgeKey = 0x10100004, CuttingSectionKey = 0x10100005, CylinderKey = 0x10100006,
  EllipseKey = 0x10100007, EllipticalArcKey = 0x10100008, InfiniteLineKey = 0x10100009, LineKey = 0x1010000A,
  DistantLightKey = 0x1010000B, SpotlightKey = 0x1010000C, MarkerKey = 0x1010000D, MeshKey = 0x1010000E,
  NURBSCurveKey = 0x1010000F, NURBSSurfaceKey = 0x10100010, PolygonKey = 0x10100011, ShellKey = 0x10100012,
  SphereKey = 0x10100013, TextKey = 0x10100014, GridKey = 0x10100015, Definition = 0x20000000,
  NamedStyleDefinition = 0x20000001, TextureDefinition = 0x20000002, LinePatternDefinition = 0x20000003, GlyphDefinition = 0x20000004,
  CubeMapDefinition = 0x20000005, ImageDefinition = 0x20000006, MaterialPaletteDefinition = 0x20000007, ShaderDefinition = 0x20000008,
  Control = 0x50000000, CameraControl = 0x50000001, SelectabilityControl = 0x50000002, MarkerAttributeControl = 0x50000003,
  SphereAttributeControl = 0x50000004, LightingAttributeControl = 0x50000005, CylinderAttributeControl = 0x50000006, TextAttributeControl = 0x50000007,
  LineAttributeControl = 0x50000008, EdgeAttributeControl = 0x50000009, CurveAttributeControl = 0x5000000A, ModellingMatrixControl = 0x5000000B,
  TextureMatrixControl = 0x5000000C, CullingControl = 0x5000000D, TransparencyControl = 0x5000000E, MaterialMappingControl = 0x5000000F,
  NURBSSurfaceAttributeControl = 0x50000010, PostProcessEffectsControl = 0x50000011, BoundingControl = 0x50000012, VisualEffectsControl = 0x50000013,
  SelectionOptionsControl = 0x50000014, HighlightOptionsControl = 0x50000015, DefinitionControl = 0x50000016, SelectionControl = 0x50000017,
  HighlightControl = 0x50000018, StandAloneWindowOptionsControl = 0x50000019, OffScreenWindowOptionsControl = 0x5000001A, ApplicationWindowOptionsControl = 0x5000001B,
  VisibilityControl = 0x5000001C, SubwindowControl = 0x5000001D, PerformanceControl = 0x5000001E, HiddenLineAttributeControl = 0x5000001F,
  DrawingAttributeControl = 0x50000020, DebuggingControl = 0x50000021, ContourLineControl = 0x50000022, StyleControl = 0x50000023,
  ConditionControl = 0x50000024, PortfolioControl = 0x50000025, WindowInfoControl = 0x50000026, AttributeLockControl = 0x50000027,
  TransformMaskControl = 0x50000028, ColorInterpolationControl = 0x50000029, UpdateOptionsControl = 0x50000030, CuttingSectionAttributeControl = 0x50000031,
  LibraryMask = 0x80FF0000, Sprocket = 0x80000000, Canvas = 0x80000001, Layout = 0x80000002,
  View = 0x80000003, Model = 0x80000004, Operator = 0x80000005, SprocketPath = 0x80000007,
  SprocketControl = 0xD0000000, OperatorControl = 0xD0000008, NavigationCubeControl = 0xD0000009, AxisTriadControl = 0xD000000A,
  Metadata = 0x80001000, IntegerMetadata = 0x80001001, UnsignedIntegerMetadata = 0x80001002, DoubleMetadata = 0x80001003,
  StringMetadata = 0x80001004, TimeMetadata = 0x80001005, BooleanMetadata = 0x80001006, Component = 0x80000200,
  Filter = 0x80000600, Capture = 0x80000A00, CADModel = 0x80000300, ComponentPath = 0x81001000,
  ExchangeMask = 0x80020000, ExchangeComponent = 0x80021200, ExchangeFilter = 0x80020601, ExchangeCapture = 0x80020A01,
  ExchangeCADModel = 0x80020301, ExchangeConfiguration = 0x81020001, ExchangeImportOptionsKit = 0x81020002, ExchangeExportACISOptionsKit = 0x81020003,
  ExchangeExportIGESOptionsKit = 0x81020004, ExchangeExportJTOptionsKit = 0x81020005, ExchangeExportParasolidOptionsKit = 0x81020006, ExchangeExportPRCOptionsKit = 0x81020007,
  ExchangeExportSTEPOptionsKit = 0x81020008, ExchangeExportSTLOptionsKit = 0x81020009, ExchangeExportU3DOptionsKit = 0x8102000A, ExchangeExportXMLOptionsKit = 0x8102000B,
  ExchangeTessellationOptionsKit = 0x8102000C, ExchangeSheet = 0x80021201, ExchangeModelFileImportOptionsKit = 0x8102000D, ExchangeTranslationOptionsKit = 0x8102000E,
  PublishMask = 0x80040000, PublishDocumentKit = 0x81040001, PublishPageKit = 0x81040002, PublishTemplateKit = 0x81040003,
  PublishAnnotationKit = 0x81040004, PublishArtworkKit = 0x81040005, PublishViewKit = 0x81040006, PublishTextKit = 0x81040007,
  PublishImageKit = 0x81040008, PublishTableKit = 0x81040009, PublishExportOptionsKit = 0x8104000A, PublishLinkKit = 0x8104000B,
  PublishButtonKit = 0x8104000C, PublishTextFieldKit = 0x8104000D, PublishSlideTableKit = 0x8104000E, PublishCheckBoxKit = 0x8104000F,
  PublishRadioButtonKit = 0x81040010, PublishListBoxKit = 0x81040011, PublishDropDownListKit = 0x81040012, PublishSignatureFieldKit = 0x81040013,
  PublishDocumentKey = 0x80040001, PublishPageControl = 0x80040002, SceneTree = 0x80008001, SceneTreeItem = 0x80008002,
  ComponentTree = 0x80008003, ComponentTreeItem = 0x80008004, SketchupMask = 0x80100000, SketchupImportOptionsKit = 0x81100001,
  SketchupImportResultsKit = 0x81100002, ParasolidMask = 0x80200000, ParasolidComponent = 0x80201201, ParasolidCADModel = 0x80200302,
  ParasolidImportOptionsKit = 0x81200003, ParasolidFacetTessellationKit = 0x81200004, ParasolidLineTessellationKit = 0x81200005, ParasolidExportOptionsKit = 0x81200006,
  IONotifierData = 0x84000200, StreamImportNotifierData = 0x84000201, STLImportNotifierData = 0x84000202, OBJImportNotifierData = 0x84000203,
  ExchangeImportNotifierData = 0x84020204, SketchupImportNotifierData = 0x84100205, ParasolidImportNotifierData = 0x84200206, ExchangeTranslationNotifierData = 0x84020207,
  ExchangeExportNotifierData = 0x84020208, StreamExportNotifierData = 0x84000209
}
 
enum  KeyboardCode {
  None = 0, Backspace = 8, Tab = 9, Clear = 11,
  Return = 13, Shift = 16, Control = 17, Alt = 18,
  Pause = 19, Escape = 27, Space = 32, ExclamationMark = 33,
  DoubleQuote = 34, Number = 35, Dollar = 36, Percent = 37,
  Ampersand = 38, SingleQuote = 39, OpenParen = 40, CloseParen = 41,
  Asterisk = 42, Plus = 43, Comma = 44, Hyphen = 45,
  Period = 46, Slash = 47, D0 = 48, D1 = 49,
  D2 = 50, D3 = 51, D4 = 52, D5 = 53,
  D6 = 54, D7 = 55, D8 = 56, D9 = 57,
  Colon = 58, Semicolon = 59, LessThan = 60, Equal = 61,
  GreaterThan = 62, QuestionMark = 63, AtSymbol = 64, A = 65,
  B = 66, C = 67, D = 68, E = 69,
  F = 70, G = 71, H = 72, I = 73,
  J = 74, K = 75, L = 76, M = 77,
  N = 78, O = 79, P = 80, Q = 81,
  R = 82, S = 83, T = 84, U = 85,
  V = 86, W = 87, X = 88, Y = 89,
  Z = 90, OpenBrackets = 91, Backslash = 92, CloseBrackets = 93,
  Caret = 94, Underscore = 95, Backtick = 96, a = 97,
  b = 98, c = 99, d = 100, e = 101,
  f = 102, g = 103, h = 104, i = 105,
  j = 106, k = 107, l = 108, m = 109,
  n = 110, o = 111, p = 112, q = 113,
  r = 114, s = 115, t = 116, u = 117,
  v = 118, w = 119, x = 120, y = 121,
  z = 122, OpenBrace = 123, VerticalBar = 124, ClosingBrace = 125,
  Tilde = 126, Delete = 127, Insert = 1024, Home = 1025,
  End = 1026, PageUp = 1027, PageDown = 1028, Help = 1029,
  Left = 1030, Up = 1031, Right = 1032, Down = 1033,
  NumPad0 = 1034, NumPad1 = 1035, NumPad2 = 1036, NumPad3 = 1037,
  NumPad4 = 1038, NumPad5 = 1039, NumPad6 = 1040, NumPad7 = 1041,
  NumPad8 = 1042, NumPad9 = 1043, F1 = 1044, F2 = 1045,
  F3 = 1046, F4 = 1047, F5 = 1048, F6 = 1049,
  F7 = 1050, F8 = 1051, F9 = 1052, F10 = 1053,
  F11 = 1054, F12 = 1055, F13 = 1056, F14 = 1057,
  F15 = 1058, F16 = 1059, F17 = 1060, F18 = 1061,
  F19 = 1062, F20 = 1063, F21 = 1064, F22 = 1065,
  F23 = 1066, F24 = 1067
}