REFERENCE MANUAL
The DrawingAttributeControl class is a smart pointer that is tied to a database object. More...
Public Member Functions | |
override void | Dispose () |
DrawingAttributeControl (HPS.SegmentKey in_seg) | |
Initializes a control tied to the segment in_seg. More... | |
DrawingAttributeControl (HPS.DrawingAttributeControl in_that) | |
Initializes a control tied to the same object as in_that. More... | |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. More... | |
HPS.DrawingAttributeControl | SetClipRegion (HPS.Point[] in_points, HPS.Drawing.ClipSpace in_space, HPS.Drawing.ClipOperation in_operation) |
Specifies a clip region. More... | |
HPS.DrawingAttributeControl | SetClipRegion (HPS.Point[] in_points, HPS.Drawing.ClipSpace in_space) |
Specifies a clip region. More... | |
HPS.DrawingAttributeControl | SetClipRegion (HPS.Point[] in_points) |
Specifies a clip region. More... | |
HPS.DrawingAttributeControl | SetClipRegion (ulong in_number_of_points, HPS.Point[] in_points, HPS.Drawing.ClipSpace in_space, HPS.Drawing.ClipOperation in_operation) |
Specifies a clip region. More... | |
HPS.DrawingAttributeControl | SetClipRegion (ulong in_number_of_points, HPS.Point[] in_points, HPS.Drawing.ClipSpace in_space) |
Specifies a clip region. More... | |
HPS.DrawingAttributeControl | SetClipRegion (ulong in_number_of_points, HPS.Point[] in_points) |
Specifies a clip region. More... | |
HPS.DrawingAttributeControl | 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.DrawingAttributeControl | 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.DrawingAttributeControl | SetClipRegion (HPS.Point[][] in_loops) |
Sets a complex polygonal clip region defined by the XOR of a series of loops. More... | |
HPS.DrawingAttributeControl | SetDeferral (int in_deferral) |
Specifies a drawing order for a segment during timed updates. More... | |
HPS.DrawingAttributeControl | SetDepthRange (float in_near, float in_far) |
Compresses effective Z values into a subset of what they would otherwise have been. More... | |
HPS.DrawingAttributeControl | 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.DrawingAttributeControl | SetFaceDisplacement (bool in_state) |
Specifies a number of Z-buffer units that rendered faces should be pushed away from the camera. More... | |
HPS.DrawingAttributeControl | SetFaceDisplacement (int in_buckets) |
Specifies a number of Z-buffer units that rendered faces should be pushed away from the camera. More... | |
HPS.DrawingAttributeControl | 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.DrawingAttributeControl | SetGeneralDisplacement (bool in_state) |
Specifies a number of Z-buffer units that all geometry should be pushed away from the camera. More... | |
HPS.DrawingAttributeControl | SetGeneralDisplacement (int in_buckets) |
Specifies a number of Z-buffer units that all geometry should be pushed away from the camera. More... | |
HPS.DrawingAttributeControl | 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.DrawingAttributeControl | SetPolygonHandedness (HPS.Drawing.Handedness in_handedness) |
In order to do a back face culling, there must be some definition of a polygon's "front" and "back". More... | |
HPS.DrawingAttributeControl | 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.DrawingAttributeControl | SetVertexDisplacement (bool in_state) |
Specifies a number of Z-buffer units that vertices should be pushed away from the camera. More... | |
HPS.DrawingAttributeControl | SetVertexDisplacement (int in_buckets) |
Specifies a number of Z-buffer units that vertices should be pushed away from the camera. More... | |
HPS.DrawingAttributeControl | SetWorldHandedness (HPS.Drawing.Handedness in_handedness) |
The world handedness determines the orientation of the Z-axis in the Cartesian coordinate system. More... | |
bool | ShowClipRegion (out HPS.Point[][] out_loops, out HPS.Drawing.ClipSpace out_space, HPS.Drawing.ClipOperation ou_operation) |
Shows the clip region setting. More... | |
bool | ShowDeferral (out int out_defer_batch) |
Shows the deferral setting. More... | |
bool | ShowDepthRange (out float out_x, out float out_y) |
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.DrawingAttributeControl | UnsetClipRegion () |
Removes a clip region setting. More... | |
HPS.DrawingAttributeControl | UnsetDeferral () |
Removes a deferral setting. More... | |
HPS.DrawingAttributeControl | UnsetDepthRange () |
Removes a depth range setting. More... | |
HPS.DrawingAttributeControl | UnsetEverything () |
Removes all settings from this object. More... | |
HPS.DrawingAttributeControl | UnsetFaceDisplacement () |
Removes a face displacement setting. More... | |
HPS.DrawingAttributeControl | UnsetGeneralDisplacement () |
Removes a general displacement setting. More... | |
HPS.DrawingAttributeControl | UnsetOverlay () |
Removes an overlay setting. More... | |
HPS.DrawingAttributeControl | UnsetPolygonHandedness () |
Removes a polygon handedness setting. More... | |
HPS.DrawingAttributeControl | UnsetVertexDisplacement () |
Removes a vertex displacement setting. More... | |
HPS.DrawingAttributeControl | UnsetWorldHandedness () |
Removes a world handedness setting. More... | |
![]() | |
Control (HPS.Control in_that) | |
![]() | |
virtual bool | Empty () |
Indicates whether this object has any values set on it. 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... | |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
static IntPtr | ClassID< T > () |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
HandleRef | scptr |
The 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.
Global attributes:
world handedness, polygon handedness, priority, depth range
Segment-level attributes:
overlay, deferral, face displacement, general displacement, clip regions
This table lists default values for the various segment attributes accessible from DrawingAttributeControl.
HPS.DrawingAttributeControl.DrawingAttributeControl | ( | HPS.SegmentKey | in_seg | ) |
Initializes a control tied to the segment in_seg.
HPS.DrawingAttributeControl.DrawingAttributeControl | ( | HPS.DrawingAttributeControl | in_that | ) |
Initializes a control tied to the same object as in_that.
|
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.
HPS.DrawingAttributeControl HPS.DrawingAttributeControl.SetClipRegion | ( | HPS.Point[] | in_points, |
HPS.Drawing.ClipSpace | in_space, | ||
HPS.Drawing.ClipOperation | in_operation | ||
) |
Specifies a clip region.
in_points | An array of points specifying the shape of the clip region. |
in_space | The space coordinated in which the points are specified. |
in_operation | The operation performed by this clip region. |
HPS.DrawingAttributeControl HPS.DrawingAttributeControl.SetClipRegion | ( | HPS.Point[] | in_points, |
HPS.Drawing.ClipSpace | in_space | ||
) |
Specifies a clip region.
in_points | An array of points specifying the shape of the clip region. |
in_space | The space coordinated in which the points are specified. |
HPS.DrawingAttributeControl HPS.DrawingAttributeControl.SetClipRegion | ( | HPS.Point[] | in_points | ) |
Specifies a clip region.
in_points | An array of points specifying the shape of the clip region. |
HPS.DrawingAttributeControl HPS.DrawingAttributeControl.SetClipRegion | ( | ulong | in_number_of_points, |
HPS.Point[] | in_points, | ||
HPS.Drawing.ClipSpace | in_space, | ||
HPS.Drawing.ClipOperation | in_operation | ||
) |
Specifies a clip region.
in_number_of_points | The number of elements in in_points |
in_points | An array of points specifying the shape of the clip region. |
in_space | The space coordinated in which the points are specified. |
in_operation | The operation performed by this clip region. |
HPS.DrawingAttributeControl HPS.DrawingAttributeControl.SetClipRegion | ( | ulong | in_number_of_points, |
HPS.Point[] | in_points, | ||
HPS.Drawing.ClipSpace | in_space | ||
) |
Specifies a clip region.
in_number_of_points | The number of elements in in_points |
in_points | An array of points specifying the shape of the clip region. |
in_space | The space coordinated in which the points are specified. |
HPS.DrawingAttributeControl HPS.DrawingAttributeControl.SetClipRegion | ( | ulong | in_number_of_points, |
HPS.Point[] | in_points | ||
) |
Specifies a clip region.
in_number_of_points | The number of elements in in_points |
in_points | An array of points specifying the shape of the clip region. |
HPS.DrawingAttributeControl HPS.DrawingAttributeControl.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.DrawingAttributeControl HPS.DrawingAttributeControl.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.DrawingAttributeControl HPS.DrawingAttributeControl.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.DrawingAttributeControl HPS.DrawingAttributeControl.SetDeferral | ( | int | in_deferral | ) |
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. Segments have a default value of 0.
HPS.DrawingAttributeControl HPS.DrawingAttributeControl.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.DrawingAttributeControl HPS.DrawingAttributeControl.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.DrawingAttributeControl HPS.DrawingAttributeControl.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.DrawingAttributeControl HPS.DrawingAttributeControl.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.DrawingAttributeControl HPS.DrawingAttributeControl.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.DrawingAttributeControl HPS.DrawingAttributeControl.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.DrawingAttributeControl HPS.DrawingAttributeControl.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.DrawingAttributeControl HPS.DrawingAttributeControl.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.DrawingAttributeControl HPS.DrawingAttributeControl.SetPolygonHandedness | ( | HPS.Drawing.Handedness | in_handedness | ) |
In order to do a back face culling, there must be some definition of a polygon's "front" and "back".
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). If you wrap the fingers of the chosen hand along the vertices of the polygon, with your wrist at the first vertex and your fingertips at the last, then extend your thumb perpendicular to your fingers, your thumb is extending out of the front face of the polygon.
in_handedness | The handedness to be used for geometry. |
HPS.DrawingAttributeControl HPS.DrawingAttributeControl.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.DrawingAttributeControl HPS.DrawingAttributeControl.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.DrawingAttributeControl HPS.DrawingAttributeControl.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.DrawingAttributeControl HPS.DrawingAttributeControl.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. |
bool HPS.DrawingAttributeControl.ShowClipRegion | ( | out HPS.Point | out_loops[][], |
out HPS.Drawing.ClipSpace | out_space, | ||
HPS.Drawing.ClipOperation | ou_operation | ||
) |
Shows the clip region setting.
out_loops | An array of loops sspecifying the shape of the clip region. |
out_space | The coordinate space the points are specified in. |
ou_operation | The operation performed by this clip region. |
bool HPS.DrawingAttributeControl.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.DrawingAttributeControl.ShowDepthRange | ( | out float | out_x, |
out float | out_y | ||
) |
Shows the depth range setting.
bool HPS.DrawingAttributeControl.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.DrawingAttributeControl.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.DrawingAttributeControl.ShowOverlay | ( | out HPS.Drawing.Overlay | out_overlay | ) |
Shows the overlay setting.
out_overlay | The type of overlay, if any, used. |
bool HPS.DrawingAttributeControl.ShowPolygonHandedness | ( | out HPS.Drawing.Handedness | out_handedness | ) |
Shows the polygon handedness.
out_handedness | The handedness used for geometry. |
bool HPS.DrawingAttributeControl.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.DrawingAttributeControl.ShowWorldHandedness | ( | out HPS.Drawing.Handedness | out_handedness | ) |
Shows the world handedness.
out_handedness | The handedness of the underlying coordinate system. |
HPS.DrawingAttributeControl HPS.DrawingAttributeControl.UnsetClipRegion | ( | ) |
Removes a clip region setting.
HPS.DrawingAttributeControl HPS.DrawingAttributeControl.UnsetDeferral | ( | ) |
Removes a deferral setting.
HPS.DrawingAttributeControl HPS.DrawingAttributeControl.UnsetDepthRange | ( | ) |
Removes a depth range setting.
HPS.DrawingAttributeControl HPS.DrawingAttributeControl.UnsetEverything | ( | ) |
Removes all settings from this object.
HPS.DrawingAttributeControl HPS.DrawingAttributeControl.UnsetFaceDisplacement | ( | ) |
Removes a face displacement setting.
HPS.DrawingAttributeControl HPS.DrawingAttributeControl.UnsetGeneralDisplacement | ( | ) |
Removes a general displacement setting.
HPS.DrawingAttributeControl HPS.DrawingAttributeControl.UnsetOverlay | ( | ) |
Removes an overlay setting.
HPS.DrawingAttributeControl HPS.DrawingAttributeControl.UnsetPolygonHandedness | ( | ) |
Removes a polygon handedness setting.
HPS.DrawingAttributeControl HPS.DrawingAttributeControl.UnsetVertexDisplacement | ( | ) |
Removes a vertex displacement setting.
HPS.DrawingAttributeControl HPS.DrawingAttributeControl.UnsetWorldHandedness | ( | ) |
Removes a world handedness setting.