REFERENCE MANUAL
The DrawingAttributeKit class is a user space object, useful for carrying a group attribute settings. More...
Public Member Functions | |
override void | Dispose () |
DrawingAttributeKit () | |
Initializes an empty kit. More... | |
DrawingAttributeKit (HPS.DrawingAttributeKit in_kit) | |
The copy constructor creates a new DrawingAttributeKit object that contains the same settings as the source object. More... | |
override bool | Empty () |
Indicates whether this object has any values set on it. More... | |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.DrawingAttributeKit in_kit) |
Check if the source DrawingAttributeKit is equivalent to this object. More... | |
override int | GetHashCode () |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. More... | |
void | Set (HPS.DrawingAttributeKit in_kit) |
Copies the source DrawingAttributeKit into this object. More... | |
HPS.DrawingAttributeKit | SetClipRegion (HPS.Point[] in_points, HPS.Drawing.ClipSpace in_space, HPS.Drawing.ClipOperation in_operation) |
Sets a polygonal clip region. More... | |
HPS.DrawingAttributeKit | SetClipRegion (HPS.Point[] in_points, HPS.Drawing.ClipSpace in_space) |
Sets a polygonal clip region. More... | |
HPS.DrawingAttributeKit | SetClipRegion (HPS.Point[] in_points) |
Sets a polygonal clip region. More... | |
HPS.DrawingAttributeKit | SetClipRegion (ulong in_number_of_points, HPS.Point[] in_points, HPS.Drawing.ClipSpace in_space, HPS.Drawing.ClipOperation in_operation) |
Sets a polygonal clip region. More... | |
HPS.DrawingAttributeKit | SetClipRegion (ulong in_number_of_points, HPS.Point[] in_points, HPS.Drawing.ClipSpace in_space) |
Sets a polygonal clip region. More... | |
HPS.DrawingAttributeKit | SetClipRegion (ulong in_number_of_points, HPS.Point[] in_points) |
Sets a polygonal clip region. More... | |
HPS.DrawingAttributeKit | SetClipRegion (HPS.Point[][] in_loops, HPS.Drawing.ClipSpace in_space, HPS.Drawing.ClipOperation in_operation) |
Sets a complex polygonal clip region defined by the XOR of a series of loops. More... | |
HPS.DrawingAttributeKit | SetClipRegion (HPS.Point[][] in_loops, HPS.Drawing.ClipSpace in_space) |
Sets a complex polygonal clip region defined by the XOR of a series of loops. More... | |
HPS.DrawingAttributeKit | SetClipRegion (HPS.Point[][] in_loops) |
Sets a complex polygonal clip region defined by the XOR of a series of loops. More... | |
HPS.DrawingAttributeKit | SetDeferral (int in_defer_batch) |
Specifies a drawing order for a segment during timed updates. More... | |
HPS.DrawingAttributeKit | SetDepthRange (float in_near, float in_far) |
Compresses effective Z values into a subset of what they would otherwise have been. More... | |
HPS.DrawingAttributeKit | SetFaceDisplacement (bool in_state, int in_buckets) |
Specifies a number of Z-buffer units that rendered faces should be pushed away from the camera. More... | |
HPS.DrawingAttributeKit | SetFaceDisplacement (bool in_state) |
Specifies a number of Z-buffer units that rendered faces should be pushed away from the camera. More... | |
HPS.DrawingAttributeKit | SetFaceDisplacement (int in_buckets) |
Specifies a number of Z-buffer units that rendered faces should be pushed away from the camera. More... | |
HPS.DrawingAttributeKit | SetGeneralDisplacement (bool in_state, int in_buckets) |
Specifies a number of Z-buffer units that all geometry should be pushed away from the camera. More... | |
HPS.DrawingAttributeKit | SetGeneralDisplacement (bool in_state) |
Specifies a number of Z-buffer units that all geometry should be pushed away from the camera. More... | |
HPS.DrawingAttributeKit | SetGeneralDisplacement (int in_buckets) |
Specifies a number of Z-buffer units that all geometry should be pushed away from the camera. More... | |
HPS.DrawingAttributeKit | SetOverlay (HPS.Drawing.Overlay in_overlay) |
Allows moving, editing, or deleting to take place in a segment without triggering a full-screen redraw. More... | |
HPS.DrawingAttributeKit | SetPolygonHandedness (HPS.Drawing.Handedness in_handedness) |
In order to perform back face culling, there must be some definition of a polygon's "front" and "back" faces. More... | |
HPS.DrawingAttributeKit | SetVertexDisplacement (bool in_state, int in_buckets) |
Specifies a number of Z-buffer units that vertices should be pushed away from the camera. More... | |
HPS.DrawingAttributeKit | SetVertexDisplacement (bool in_state) |
Specifies a number of Z-buffer units that vertices should be pushed away from the camera. More... | |
HPS.DrawingAttributeKit | SetVertexDisplacement (int in_buckets) |
Specifies a number of Z-buffer units that vertices should be pushed away from the camera. More... | |
HPS.DrawingAttributeKit | SetWorldHandedness (HPS.Drawing.Handedness in_handedness) |
The world handedness determines the orientation of the Z-axis in the Cartesian coordinate system. More... | |
void | Show (out HPS.DrawingAttributeKit out_kit) |
Copies this object into the given DrawingAttributeKit. More... | |
bool | ShowClipRegion (out HPS.Point[][] out_loops, out HPS.Drawing.ClipSpace out_space, out HPS.Drawing.ClipOperation out_operation) |
Shows the clip region settings. More... | |
bool | ShowDeferral (out int out_defer_batch) |
Shows the deferral setting. More... | |
bool | ShowDepthRange (out float out_near, out float out_far) |
Shows the depth range setting. More... | |
bool | ShowFaceDisplacement (out bool out_state, out int out_buckets) |
Shows the face displacement setting. More... | |
bool | ShowGeneralDisplacement (out bool out_state, out int out_buckets) |
Shows the general displacement setting. More... | |
bool | ShowOverlay (out HPS.Drawing.Overlay out_overlay) |
Shows the overlay setting. More... | |
bool | ShowPolygonHandedness (out HPS.Drawing.Handedness out_handedness) |
Shows the polygon handedness. More... | |
bool | ShowVertexDisplacement (out bool out_state, out int out_buckets) |
Shows the vertex displacement setting. More... | |
bool | ShowWorldHandedness (out HPS.Drawing.Handedness out_handedness) |
Shows the world handedness. More... | |
HPS.DrawingAttributeKit | UnsetClipRegion () |
Removes a clip region. More... | |
HPS.DrawingAttributeKit | UnsetDeferral () |
Removes a deferral setting. More... | |
HPS.DrawingAttributeKit | UnsetDepthRange () |
Removes a depth range setting. More... | |
HPS.DrawingAttributeKit | UnsetEverything () |
Removes all settings from this object. More... | |
HPS.DrawingAttributeKit | UnsetFaceDisplacement () |
Removes a face displacement setting. More... | |
HPS.DrawingAttributeKit | UnsetGeneralDisplacement () |
Removes a general displacement setting. More... | |
HPS.DrawingAttributeKit | UnsetOverlay () |
Removes an overlay setting. More... | |
HPS.DrawingAttributeKit | UnsetPolygonHandedness () |
Removes a polygon handedness setting. More... | |
HPS.DrawingAttributeKit | UnsetVertexDisplacement () |
Removes a vertex displacement setting. More... | |
HPS.DrawingAttributeKit | UnsetWorldHandedness () |
Removes a world handedness setting. More... | |
![]() | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns an identifier that can be used to identify which instance of a class an object is. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
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... | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
HPS.Type | Type () |
This function returns the true type of the underlying object. More... | |
Static Public Member Functions | |
static HPS.DrawingAttributeKit | GetDefault () |
Creates a DrawingAttributeKit which contains the default settings. More... | |
static bool | operator!= (HPS.DrawingAttributeKit a, HPS.DrawingAttributeKit b) |
static bool | operator== (HPS.DrawingAttributeKit a, HPS.DrawingAttributeKit b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
HandleRef | scptr |
The DrawingAttributeKit class is a user space object, useful for carrying a group attribute settings.
Calling DrawingAttributeKit::GetDefault() will return a kit with values found in this table.
HPS.DrawingAttributeKit.DrawingAttributeKit | ( | ) |
Initializes an empty kit.
HPS.DrawingAttributeKit.DrawingAttributeKit | ( | HPS.DrawingAttributeKit | in_kit | ) |
The copy constructor creates a new DrawingAttributeKit object that contains the same settings as the source object.
in_kit | The source object to copy. |
|
virtual |
Indicates whether this object has any values set on it.
Reimplemented from HPS.Object.
bool HPS.DrawingAttributeKit.Equals | ( | HPS.DrawingAttributeKit | in_kit | ) |
Check if the source DrawingAttributeKit is equivalent to this object.
in_kit | The source <ref refid="class_h_p_s_1_1_drawing_attribute_kit" kindref="compound">DrawingAttributeKit</ref> to compare to this object. |
|
static |
Creates a DrawingAttributeKit 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.
|
virtual |
This function returns the type the object, as declared.
This does not necessarily give the true type of the underlying object.
Reimplemented from HPS.Object.
void HPS.DrawingAttributeKit.Set | ( | HPS.DrawingAttributeKit | in_kit | ) |
Copies the source DrawingAttributeKit into this object.
in_kit | The source object to copy. |
HPS.DrawingAttributeKit HPS.DrawingAttributeKit.SetClipRegion | ( | HPS.Point[] | in_points, |
HPS.Drawing.ClipSpace | in_space, | ||
HPS.Drawing.ClipOperation | in_operation | ||
) |
Sets a polygonal clip region.
in_points | An array of points describing the clip region. |
in_space | The coordinate space in which in_points are specified. |
in_operation | The operation performed by the clip region. |
HPS.DrawingAttributeKit HPS.DrawingAttributeKit.SetClipRegion | ( | HPS.Point[] | in_points, |
HPS.Drawing.ClipSpace | in_space | ||
) |
Sets a polygonal clip region.
in_points | An array of points describing the clip region. |
in_space | The coordinate space in which in_points are specified. |
HPS.DrawingAttributeKit HPS.DrawingAttributeKit.SetClipRegion | ( | HPS.Point[] | in_points | ) |
Sets a polygonal clip region.
in_points | An array of points describing the clip region. |
HPS.DrawingAttributeKit HPS.DrawingAttributeKit.SetClipRegion | ( | ulong | in_number_of_points, |
HPS.Point[] | in_points, | ||
HPS.Drawing.ClipSpace | in_space, | ||
HPS.Drawing.ClipOperation | in_operation | ||
) |
Sets a polygonal clip region.
in_number_of_points | The number of points in in_points. |
in_points | An array of points describing the clip region. |
in_space | The coordinate space in which in_points are specified. |
in_operation | The operation performed by the clip region. |
HPS.DrawingAttributeKit HPS.DrawingAttributeKit.SetClipRegion | ( | ulong | in_number_of_points, |
HPS.Point[] | in_points, | ||
HPS.Drawing.ClipSpace | in_space | ||
) |
Sets a polygonal clip region.
in_number_of_points | The number of points in in_points. |
in_points | An array of points describing the clip region. |
in_space | The coordinate space in which in_points are specified. |
HPS.DrawingAttributeKit HPS.DrawingAttributeKit.SetClipRegion | ( | ulong | in_number_of_points, |
HPS.Point[] | in_points | ||
) |
Sets a polygonal clip region.
in_number_of_points | The number of points in in_points. |
in_points | An array of points describing the clip region. |
HPS.DrawingAttributeKit HPS.DrawingAttributeKit.SetClipRegion | ( | HPS.Point | in_loops[][], |
HPS.Drawing.ClipSpace | in_space, | ||
HPS.Drawing.ClipOperation | in_operation | ||
) |
Sets a complex polygonal clip region defined by the XOR of a series of loops.
in_loops | An array of loops describing clip regions. |
in_space | The coordinate space in which in_loops are specified. |
in_operation | The operation performed by the clip region. |
HPS.DrawingAttributeKit HPS.DrawingAttributeKit.SetClipRegion | ( | HPS.Point | in_loops[][], |
HPS.Drawing.ClipSpace | in_space | ||
) |
Sets a complex polygonal clip region defined by the XOR of a series of loops.
in_loops | An array of loops describing clip regions. |
in_space | The coordinate space in which in_loops are specified. |
HPS.DrawingAttributeKit HPS.DrawingAttributeKit.SetClipRegion | ( | HPS.Point | in_loops[][] | ) |
Sets a complex polygonal clip region defined by the XOR of a series of loops.
in_loops | An array of loops describing clip regions. |
HPS.DrawingAttributeKit HPS.DrawingAttributeKit.SetDeferral | ( | int | in_defer_batch | ) |
Specifies a drawing order for a segment during timed updates.
Segments with a lower deferral value will be drawn before segments with a higher value. This attribute does not inherit like most attributes and segments have a default value of 0.
in_defer_batch | A drawing priority, with negative values drawing earlier than usual and positive values drawing later than usual. |
HPS.DrawingAttributeKit HPS.DrawingAttributeKit.SetDepthRange | ( | float | in_near, |
float | in_far | ||
) |
Compresses effective Z values into a subset of what they would otherwise have been.
This allows certain pieces of the scene to be drawn on top at all times without additional sub-windows. Values of (0,0) will force all geometry into the frontmost bucket, but will have the drawback that it will cause z-fighting amongst the geometry that shares that setting. To get such pieces of geometry to resolve reasonably well against each other, a range of (0,0.1) should perform reasonably well.
HPS.DrawingAttributeKit HPS.DrawingAttributeKit.SetFaceDisplacement | ( | bool | in_state, |
int | in_buckets | ||
) |
Specifies a number of Z-buffer units that rendered faces should be pushed away from the camera.
This can be used to reduce edge stitching by ensuring that coincident edges lay on top of the faces. Negative face displacements will push faces toward the camera.
in_state | Whether face displacement should be used. |
in_buckets | The distance to move rendered faces away from the camera. |
HPS.DrawingAttributeKit HPS.DrawingAttributeKit.SetFaceDisplacement | ( | bool | in_state | ) |
Specifies a number of Z-buffer units that rendered faces should be pushed away from the camera.
This can be used to reduce edge stitching by ensuring that coincident edges lay on top of the faces. Negative face displacements will push faces toward the camera.
in_state | Whether face displacement should be used. |
HPS.DrawingAttributeKit HPS.DrawingAttributeKit.SetFaceDisplacement | ( | int | in_buckets | ) |
Specifies a number of Z-buffer units that rendered faces should be pushed away from the camera.
The state is implicitly on.
in_buckets | The distance to move rendered faces away from the camera. |
HPS.DrawingAttributeKit HPS.DrawingAttributeKit.SetGeneralDisplacement | ( | bool | in_state, |
int | in_buckets | ||
) |
Specifies a number of Z-buffer units that all geometry should be pushed away from the camera.
This can be used to ensure that certain geometry is drawn on top of or behind the rest of the scene. Negative general displacements will push geometry toward the camera.
in_state | Whether general displacement should be used. |
in_buckets | The distance to move rendered geometry away from the camera. |
HPS.DrawingAttributeKit HPS.DrawingAttributeKit.SetGeneralDisplacement | ( | bool | in_state | ) |
Specifies a number of Z-buffer units that all geometry should be pushed away from the camera.
This can be used to ensure that certain geometry is drawn on top of or behind the rest of the scene. Negative general displacements will push geometry toward the camera.
in_state | Whether general displacement should be used. |
HPS.DrawingAttributeKit HPS.DrawingAttributeKit.SetGeneralDisplacement | ( | int | in_buckets | ) |
Specifies a number of Z-buffer units that all geometry should be pushed away from the camera.
The state is implicitly on.
in_buckets | The distance to move rendered geometry away from the camera. |
HPS.DrawingAttributeKit HPS.DrawingAttributeKit.SetOverlay | ( | HPS.Drawing.Overlay | in_overlay | ) |
Allows moving, editing, or deleting to take place in a segment without triggering a full-screen redraw.
in_overlay | The type of overlay, if any, to be used. |
HPS.DrawingAttributeKit HPS.DrawingAttributeKit.SetPolygonHandedness | ( | HPS.Drawing.Handedness | in_handedness | ) |
In order to perform back face culling, there must be some definition of a polygon's "front" and "back" faces.
This orientation is determined by the order in which the polygon's vertices were originally defined and the polygon handedness setting (not the world handedness).
HPS.DrawingAttributeKit HPS.DrawingAttributeKit.SetVertexDisplacement | ( | bool | in_state, |
int | in_buckets | ||
) |
Specifies a number of Z-buffer units that vertices should be pushed away from the camera.
This can be used to ensure that vertices are drawn on top of or behind other geometry. Negative general displacements will push vertices toward the camera.
in_state | Whether vertex displacement should be used. |
in_buckets | The distance to move vertices away from the camera. |
HPS.DrawingAttributeKit HPS.DrawingAttributeKit.SetVertexDisplacement | ( | bool | in_state | ) |
Specifies a number of Z-buffer units that vertices should be pushed away from the camera.
This can be used to ensure that vertices are drawn on top of or behind other geometry. Negative general displacements will push vertices toward the camera.
in_state | Whether vertex displacement should be used. |
HPS.DrawingAttributeKit HPS.DrawingAttributeKit.SetVertexDisplacement | ( | int | in_buckets | ) |
Specifies a number of Z-buffer units that vertices should be pushed away from the camera.
The state is implicitly on.
in_buckets | The distance to move rendered geometry away from the camera. |
HPS.DrawingAttributeKit HPS.DrawingAttributeKit.SetWorldHandedness | ( | HPS.Drawing.Handedness | in_handedness | ) |
The world handedness determines the orientation of the Z-axis in the Cartesian coordinate system.
If you curl the fingers of your appropriate hand from the X-axis towards the Y-axis, your thumb will point in the direction of the Z-axis.
in_handedness | The handedness of the underlying coordinate system. |
void HPS.DrawingAttributeKit.Show | ( | out HPS.DrawingAttributeKit | out_kit | ) |
Copies this object into the given DrawingAttributeKit.
out_kit | The <ref refid="class_h_p_s_1_1_drawing_attribute_kit" kindref="compound">DrawingAttributeKit</ref> to populate with the contents of this object. |
bool HPS.DrawingAttributeKit.ShowClipRegion | ( | out HPS.Point | out_loops[][], |
out HPS.Drawing.ClipSpace | out_space, | ||
out HPS.Drawing.ClipOperation | out_operation | ||
) |
Shows the clip region settings.
out_loops | An array of loops describing the clip region. |
out_space | The coordinate space in which out_loops are described. |
out_operation | The operation performed by the clip region |
bool HPS.DrawingAttributeKit.ShowDeferral | ( | out int | out_defer_batch | ) |
Shows the deferral setting.
out_defer_batch | A drawing priority, with negative values drawing earlier than usual and positive values drawing later than usual. |
bool HPS.DrawingAttributeKit.ShowDepthRange | ( | out float | out_near, |
out float | out_far | ||
) |
Shows the depth range setting.
out_near | The portion of the depth range closest to the camera. Valid range is [0,1] with out_near <= out_far. |
out_far | The portion of the depth range furthest to the camera. Valid range is [0,1] with out_near <= out_far. |
bool HPS.DrawingAttributeKit.ShowFaceDisplacement | ( | out bool | out_state, |
out int | out_buckets | ||
) |
Shows the face displacement setting.
out_state | Whether face displacement will be used. |
out_buckets | The distance to move rendered faces away from the camera. |
bool HPS.DrawingAttributeKit.ShowGeneralDisplacement | ( | out bool | out_state, |
out int | out_buckets | ||
) |
Shows the general displacement setting.
out_state | Whether general displacement will be used. |
out_buckets | The distance to move rendered geometry away from the camera. |
bool HPS.DrawingAttributeKit.ShowOverlay | ( | out HPS.Drawing.Overlay | out_overlay | ) |
Shows the overlay setting.
out_overlay | The type of overlay, if any, used. |
bool HPS.DrawingAttributeKit.ShowPolygonHandedness | ( | out HPS.Drawing.Handedness | out_handedness | ) |
Shows the polygon handedness.
out_handedness | The handedness used for geometry. |
bool HPS.DrawingAttributeKit.ShowVertexDisplacement | ( | out bool | out_state, |
out int | out_buckets | ||
) |
Shows the vertex displacement setting.
out_state | Whether vertex displacement will be used. |
out_buckets | The distance to move vertices away from the camera. |
bool HPS.DrawingAttributeKit.ShowWorldHandedness | ( | out HPS.Drawing.Handedness | out_handedness | ) |
Shows the world handedness.
out_handedness | The handedness of the underlying coordinate system. |
HPS.DrawingAttributeKit HPS.DrawingAttributeKit.UnsetClipRegion | ( | ) |
Removes a clip region.
HPS.DrawingAttributeKit HPS.DrawingAttributeKit.UnsetDeferral | ( | ) |
Removes a deferral setting.
HPS.DrawingAttributeKit HPS.DrawingAttributeKit.UnsetDepthRange | ( | ) |
Removes a depth range setting.
HPS.DrawingAttributeKit HPS.DrawingAttributeKit.UnsetEverything | ( | ) |
Removes all settings from this object.
HPS.DrawingAttributeKit HPS.DrawingAttributeKit.UnsetFaceDisplacement | ( | ) |
Removes a face displacement setting.
HPS.DrawingAttributeKit HPS.DrawingAttributeKit.UnsetGeneralDisplacement | ( | ) |
Removes a general displacement setting.
HPS.DrawingAttributeKit HPS.DrawingAttributeKit.UnsetOverlay | ( | ) |
Removes an overlay setting.
HPS.DrawingAttributeKit HPS.DrawingAttributeKit.UnsetPolygonHandedness | ( | ) |
Removes a polygon handedness setting.
HPS.DrawingAttributeKit HPS.DrawingAttributeKit.UnsetVertexDisplacement | ( | ) |
Removes a vertex displacement setting.
HPS.DrawingAttributeKit HPS.DrawingAttributeKit.UnsetWorldHandedness | ( | ) |
Removes a world handedness setting.