The Factory class is used to create and query Sprocket objects.
More...
|
override void | Dispose () |
|
override void | Dispose () |
|
| Sprocket (HPS.Sprocket in_that) |
|
IntPtr | GetClassID () |
|
| Object (HPS.Object in_that) |
| The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More...
|
|
HPS.Type | Type () |
| This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types. More...
|
|
virtual HPS.Type | ObjectType () |
| This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object. More...
|
|
virtual bool | Empty () |
| Indicates whether this object has any values set on it. More...
|
|
virtual void | Reset () |
| Resets this object to its initial, uninitialized state. More...
|
|
bool | HasType (HPS.Type in_mask) |
| This function indicates whether this Object has the given Type mask. More...
|
|
IntPtr | GetInstanceID () |
| Returns an identifier that can be used to identify which instance of a class an object is. Different keys and controls will return the same value if they are backed by the same database resource. More...
|
|
|
override void | deleteCptr () |
|
override void | deleteCptr () |
|
virtual IntPtr | GetNonDirectorClassID () |
|
|
enum | UpdateType { Synchronous = 0,
Asynchronous = 1
} |
| The type of update to perform, either synchronous or asynchronous. More...
|
|
HandleRef | cptr |
|
HandleRef | scptr |
|
bool | cMemOwn |
|
The Factory class is used to create and query Sprocket objects.
Creates a new Canvas.
- Parameters
-
in_window_handle | The window handle associated with this <ref refid="class_h_p_s_1_1_canvas" kindref="compound">Canvas</ref>. |
in_name | An optional name associated with this <ref refid="class_h_p_s_1_1_canvas" kindref="compound">Canvas</ref>. |
in_options | An ApplicationWindowOptionsKit used to specify the driver to be used by the canvas, and whether it will support anti-aliasing. |
- Returns
- The newly created Canvas.
static HPS.Canvas HPS.Factory.CreateCanvas |
( |
IntPtr |
in_window_handle, |
|
|
string |
in_name |
|
) |
| |
|
inlinestatic |
Creates a new Canvas.
- Parameters
-
in_window_handle | The window handle associated with this <ref refid="class_h_p_s_1_1_canvas" kindref="compound">Canvas</ref>. |
in_name | An optional name associated with this <ref refid="class_h_p_s_1_1_canvas" kindref="compound">Canvas</ref>. |
- Returns
- The newly created Canvas.
static HPS.Canvas HPS.Factory.CreateCanvas |
( |
IntPtr |
in_window_handle | ) |
|
|
inlinestatic |
Creates a new Canvas.
- Parameters
-
in_window_handle | The window handle associated with this <ref refid="class_h_p_s_1_1_canvas" kindref="compound">Canvas</ref>. |
- Returns
- The newly created Canvas.
Creates a new Canvas.
- Parameters
-
in_name | An optional name associated with this <ref refid="class_h_p_s_1_1_canvas" kindref="compound">Canvas</ref>. |
in_options | An StandAloneWindowOptionsKit used to specify the driver to be used by the canvas, and whether it will support anti-aliasing. |
- Returns
- The newly created Canvas.
static HPS.Canvas HPS.Factory.CreateCanvas |
( |
string |
in_name | ) |
|
|
inlinestatic |
Creates a new Canvas.
- Parameters
-
in_name | An optional name associated with this <ref refid="class_h_p_s_1_1_canvas" kindref="compound">Canvas</ref>. |
- Returns
- The newly created Canvas.
Creates a new Canvas.
- Parameters
-
in_window_key | The window key associated with this <ref refid="class_h_p_s_1_1_canvas" kindref="compound">Canvas</ref>. |
in_portfolio_key | Key to the portfolio to be associated with this <ref refid="class_h_p_s_1_1_canvas" kindref="compound">Canvas</ref>. |
in_name | An optional name associated with this <ref refid="class_h_p_s_1_1_canvas" kindref="compound">Canvas</ref>. |
- Returns
- The newly created Canvas.
Creates a new Canvas.
- Parameters
-
in_window_key | The window key associated with this <ref refid="class_h_p_s_1_1_canvas" kindref="compound">Canvas</ref>. |
in_portfolio_key | Key to the portfolio to be associated with this <ref refid="class_h_p_s_1_1_canvas" kindref="compound">Canvas</ref>. |
- Returns
- The newly created Canvas.
Creates a new Canvas.
- Parameters
-
in_window_key | The window key associated with this <ref refid="class_h_p_s_1_1_canvas" kindref="compound">Canvas</ref>. |
- Returns
- The newly created Canvas.
static HPS.Layout HPS.Factory.CreateLayout |
( |
string |
in_name | ) |
|
|
inlinestatic |
Creates a new Layout.
- Parameters
-
in_name | An optional name associated with this <ref refid="class_h_p_s_1_1_layout" kindref="compound">Layout</ref>. |
- Returns
- The newly created Layout.
static HPS.Model HPS.Factory.CreateModel |
( |
string |
in_name | ) |
|
|
inlinestatic |
Creates a new Model.
- Parameters
-
in_name | An optional name associated with this <ref refid="class_h_p_s_1_1_model" kindref="compound">Model</ref>. |
- Returns
- The newly created Model.
Creates a new Model.
- Returns
- The newly created Model.
static HPS.View HPS.Factory.CreateView |
( |
string |
in_name | ) |
|
|
inlinestatic |
Creates a new View.
- Parameters
-
in_name | An optional name associated with this <ref refid="class_h_p_s_1_1_view" kindref="compound">View</ref>. |
- Returns
- The newly created View.
static HPS.View HPS.Factory.CreateView |
( |
| ) |
|
|
inlinestatic |
Creates a new View.
- Returns
- The newly created View.
Get a list of all active CADModels (i.e. CADModels that have been created and not deleted)
- Returns
- A list of active CADModels.
Get a list of all active Canvases (i.e. Canvases that have been created and not deleted)
- Returns
- A list of active Canvases.
Get a list of all active Layouts (i.e. Layouts that have been created and not deleted)
- Returns
- A list of active Layouts.
static HPS.Model [] HPS.Factory.GetModels |
( |
| ) |
|
|
inlinestatic |
Get a list of all active Models (i.e. Models that have been created and not deleted)
- Returns
- A list of active Models.
static HPS.View [] HPS.Factory.GetViews |
( |
| ) |
|
|
inlinestatic |
Get a list of all active Views (i.e. Views that have been created and not deleted)
- Returns
- A list of active Views.
The documentation for this class was generated from the following file:
- internals/hps_sprk/source/cs/HPS.Factory.cs