
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 (if the object is derived, this does not give the true type of the derived object). 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 (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. 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. More... | |
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. 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. 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. More... | |
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. More... | |
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. 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. 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. More... | |
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. More... | |
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. 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 | SetOverrideInternalColor (HPS.VisibilityKit in_kit) |
Specifies internal color of line styles, glyphs and similar items should be overridden. 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". 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. More... | |
HPS.DrawingAttributeControl | SetVertexDecimation (float in_zero_to_one) |
Specifies an amount of vertices to draw 1 draws them all. 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. 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. More... | |
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. More... | |
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. More... | |
HPS.DrawingAttributeControl | SetVertexRandomization (bool in_state) |
Specifies vertices should be drawn in a random order. More... | |
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. More... | |
bool | ShowClipRegion (out HPS.Point[][] out_loops, out HPS.Drawing.ClipSpace out_space, out HPS.Drawing.ClipOperation out_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 | ShowOverrideInternalColor (out HPS.VisibilityKit out_kit) |
Shows the override internal color setting. More... | |
bool | ShowPolygonHandedness (out HPS.Drawing.Handedness out_handedness) |
Shows the polygon handedness. More... | |
bool | ShowVertexDecimation (out float out_zero_to_one) |
Shows the vertex decimation setting. More... | |
bool | ShowVertexDisplacement (out bool out_state, out int out_buckets) |
Shows the vertex displacement setting. More... | |
bool | ShowVertexRandomization (out bool out_state) |
Shows the vertex randomization setting. More... | |
bool | ShowWorldHandedness (out HPS.Drawing.Handedness out_handedness) |
Shows the world handedness. More... | |
override 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... | |
HPS.DrawingAttributeControl | UnsetClipRegion () |
Removes a clip region setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by DrawingAttributeKit.GetDefault(). More... | |
HPS.DrawingAttributeControl | UnsetDeferral () |
Removes a deferral setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by DrawingAttributeKit.GetDefault(). More... | |
HPS.DrawingAttributeControl | UnsetDepthRange () |
Removes a depth range setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by DrawingAttributeKit.GetDefault(). More... | |
HPS.DrawingAttributeControl | UnsetEverything () |
Removes all settings from this object. If the control is attached to a WindowKey this function restores the default settings of this control as specified by DrawingAttributeKit.GetDefault(). More... | |
HPS.DrawingAttributeControl | UnsetFaceDisplacement () |
Removes a face displacement setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by DrawingAttributeKit.GetDefault(). More... | |
HPS.DrawingAttributeControl | UnsetGeneralDisplacement () |
Removes a general displacement setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by DrawingAttributeKit.GetDefault(). More... | |
HPS.DrawingAttributeControl | UnsetOverlay () |
Removes an overlay setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by DrawingAttributeKit.GetDefault(). More... | |
HPS.DrawingAttributeControl | UnsetOverrideInternalColor () |
Removes an override internal color setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by DrawingAttributeKit.GetDefault(). More... | |
HPS.DrawingAttributeControl | UnsetPolygonHandedness () |
Removes a polygon handedness setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by DrawingAttributeKit.GetDefault(). More... | |
HPS.DrawingAttributeControl | UnsetVertexDecimation () |
Removes a vertex decimation setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by DrawingAttributeKit.GetDefault(). More... | |
HPS.DrawingAttributeControl | UnsetVertexDisplacement () |
Removes a vertex displacement setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by DrawingAttributeKit.GetDefault(). More... | |
HPS.DrawingAttributeControl | UnsetVertexRandomization () |
Removes a vertex randomization setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by DrawingAttributeKit.GetDefault(). More... | |
HPS.DrawingAttributeControl | UnsetWorldHandedness () |
Removes a world handedness setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by DrawingAttributeKit.GetDefault(). 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 the object's database handle, which can be used to determine which instance of a class the object is. For example, controls are simply aliases for segment keys that group related functions. Therefore, a SegmentKey and all of its controls would return the same instance id. Different keys and controls will return the same value if they are backed by the same database resource. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object that) | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
static IntPtr | ClassID< T > () |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
Detailed Description
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.
Global attributes: <linebreak> World handedness, polygon handedness, priority, depth range
Segment-level attributes: <linebreak> overlay, deferral, face displacement, general displacement, clip regions
This table lists default values for the various segment attributes accessible from HPS.DrawingAttributeControl.
Constructor & Destructor Documentation
|
inline |
Initializes a control tied to the segment in_seg.
|
inline |
Initializes a control tied to the same object as in_that.
Member Function Documentation
|
inlinevirtual |
This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).
- Returns
- The declared type of the object in question, which may differ from the true, underlying type.
Reimplemented from HPS.Control.
|
inline |
Specifies a clip region.
- Parameters
-
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.
- Returns
- A reference to this object.
|
inline |
Specifies a clip region.
- Parameters
-
in_points An array of points specifying the shape of the clip region. in_space The space coordinated in which the points are specified.
- Returns
- A reference to this object.
|
inline |
Specifies a clip region.
- Parameters
-
in_points An array of points specifying the shape of the clip region.
- Returns
- A reference to this object.
|
inline |
Sets a complex polygonal clip region defined by the XOR of a series of loops.
- Parameters
-
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.
- Returns
- A reference to this object.
|
inline |
Sets a complex polygonal clip region defined by the XOR of a series of loops.
- Parameters
-
in_loops An array of loops describing clip regions. in_space The coordinate space in which in_loops are specified.
- Returns
- A reference to this object.
|
inline |
Sets a complex polygonal clip region defined by the XOR of a series of loops.
- Parameters
-
in_loops An array of loops describing clip regions.
- Returns
- A reference to this object.
|
inline |
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.
- Parameters
-
in_deferral A drawing priority, with larger values drawing later than usual. Should be non-negative.
- Returns
- A reference to this object.
|
inline |
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.
|
inline |
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.
- Parameters
-
in_state Whether face displacement should be used. in_buckets The number of units to move faces in the Z-Buffer. The units are 1/2^24 in the normalized depth range [0,1]. Negative values will move faces toward the camera, positive values away from the camera.
- Returns
- A reference to this object.
|
inline |
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.
- Parameters
-
in_state Whether face displacement should be used.
- Returns
- A reference to this object.
|
inline |
Specifies a number of Z-buffer units that rendered faces should be pushed away from the camera. The state is implicitly on.
- Parameters
-
in_buckets The number of units to move faces in the Z-Buffer. The units are 1/2^24 in the normalized depth range [0,1]. Negative values will move faces toward the camera, positive values away from the camera.
- Returns
- A reference to this object.
|
inline |
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.
- Parameters
-
in_state Whether general displacement should be used. in_buckets The number of units to move rendered geometry in the Z-Buffer. The units are 1/2^24 in the normalized depth range [0,1]. Negative values will move geometry toward the camera, positive values away from the camera.
- Returns
- A reference to this object.
|
inline |
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.
- Parameters
-
in_state Whether general displacement should be used.
- Returns
- A reference to this object.
|
inline |
Specifies a number of Z-buffer units that all geometry should be pushed away from the camera. The state is implicitly on.
- Parameters
-
in_buckets The number of units to move rendered geometry in the Z-Buffer. The units are 1/2^24 in the normalized depth range [0,1]. Negative values will move geometry toward the camera, positive values away from the camera.
- Returns
- A reference to this object.
|
inline |
Allows moving, editing, or deleting to take place in a segment without triggering a full-screen redraw.
- Parameters
-
in_overlay The type of overlay, if any, to be used.
- Returns
- A reference to this object.
|
inline |
Specifies internal color of line styles, glyphs and similar items should be overridden.
- Parameters
-
in_kit Which types should internal colors should be overridden.
- Returns
- A reference to this object.
|
inline |
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.
- Parameters
-
in_handedness The handedness to be used for geometry.
- Returns
- A reference to this object.
|
inline |
Specifies an amount of vertices to draw 1 draws them all.
- Parameters
-
in_zero_to_one An amount, between [0,1], of vertices to draw.
- Returns
- A reference to this object.
|
inline |
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.
- Parameters
-
in_state Whether vertex displacement should be used. in_buckets The number of units to move vertices in the Z-Buffer. The units are 1/2^24 in the normalized depth range [0,1]. Negative values will move vertices toward the camera, positive values away from the camera.
- Returns
- A reference to this object.
|
inline |
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.
- Parameters
-
in_state Whether vertex displacement should be used.
- Returns
- A reference to this object.
|
inline |
Specifies a number of Z-buffer units that vertices should be pushed away from the camera. The state is implicitly on.
- Parameters
-
in_buckets The number of units to move vertices in the Z-Buffer. The units are 1/2^24 in the normalized depth range [0,1]. Negative values will move vertices toward the camera, positive values away from the camera.
- Returns
- A reference to this object.
|
inline |
Specifies vertices should be drawn in a random order.
- Parameters
-
in_state If true the vertices for a point cloud will be randomized.
- Returns
- A reference to this object.
|
inline |
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.
- Parameters
-
in_handedness The handedness of the underlying coordinate system.
- Returns
- A reference to this object.
|
inline |
Shows the clip region setting.
- Parameters
-
out_loops An array of loops specifying the shape of the clip region. out_space The coordinate space the points are specified in. out_operation The operation performed by this clip region.
- Returns
- true if the setting is valid, false otherwise.
|
inline |
Shows the deferral setting.
- Parameters
-
out_defer_batch A drawing priority, with negative values drawing earlier than usual and positive values drawing later than usual.
- Returns
- true if the setting is valid, false otherwise.
|
inline |
Shows the depth range setting.
- Returns
- true if the setting is valid, false otherwise.
|
inline |
Shows the face displacement setting.
- Parameters
-
out_state Whether face displacement will be used. out_buckets The distance to move rendered faces away from the camera.
- Returns
- true if the setting is valid, false otherwise.
|
inline |
Shows the general displacement setting.
- Parameters
-
out_state Whether general displacement will be used. out_buckets The distance to move rendered geometry away from the camera.
- Returns
- true if the setting is valid, false otherwise.
|
inline |
Shows the overlay setting.
- Parameters
-
out_overlay The type of overlay, if any, used.
- Returns
- true if the setting is valid, false otherwise.
|
inline |
Shows the override internal color setting.
- Parameters
-
out_kit Which override internal color types will be used.
- Returns
- true if the setting is valid, false otherwise.
|
inline |
Shows the polygon handedness.
- Parameters
-
out_handedness The handedness used for geometry.
- Returns
- true if the setting is valid, false otherwise.
|
inline |
Shows the vertex decimation setting.
- Parameters
-
out_zero_to_one The value set for vertex decimation.
- Returns
- true if the setting is valid, false otherwise.
|
inline |
Shows the vertex displacement setting.
- Parameters
-
out_state Whether vertex displacement will be used. out_buckets The distance to move vertices away from the camera.
- Returns
- true if the setting is valid, false otherwise.
|
inline |
Shows the vertex randomization setting.
- Parameters
-
out_state Whether vertex randomization will be used.
- Returns
- true if the setting is valid, false otherwise.
|
inline |
Shows the world handedness.
- Parameters
-
out_handedness The handedness of the underlying coordinate system.
- Returns
- true if the setting is valid, false otherwise.
|
inlinevirtual |
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.
- Returns
- The true type of the object in question.
Reimplemented from HPS.Control.
|
inline |
Removes a clip region setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by DrawingAttributeKit.GetDefault().
- Returns
- A reference to this object.
|
inline |
Removes a deferral setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by DrawingAttributeKit.GetDefault().
- Returns
- A reference to this object.
|
inline |
Removes a depth range setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by DrawingAttributeKit.GetDefault().
- Returns
- A reference to this object.
|
inline |
Removes all settings from this object. If the control is attached to a WindowKey this function restores the default settings of this control as specified by DrawingAttributeKit.GetDefault().
- Returns
- A reference to this object.
|
inline |
Removes a face displacement setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by DrawingAttributeKit.GetDefault().
- Returns
- A reference to this object.
|
inline |
Removes a general displacement setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by DrawingAttributeKit.GetDefault().
- Returns
- A reference to this object.
|
inline |
Removes an overlay setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by DrawingAttributeKit.GetDefault().
- Returns
- A reference to this object.
|
inline |
Removes an override internal color setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by DrawingAttributeKit.GetDefault().
- Returns
- A reference to this object.
|
inline |
Removes a polygon handedness setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by DrawingAttributeKit.GetDefault().
- Returns
- A reference to this object.
|
inline |
Removes a vertex decimation setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by DrawingAttributeKit.GetDefault().
- Returns
- A reference to this object.
|
inline |
Removes a vertex displacement setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by DrawingAttributeKit.GetDefault().
- Returns
- A reference to this object.
|
inline |
Removes a vertex randomization setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by DrawingAttributeKit.GetDefault().
- Returns
- A reference to this object.
|
inline |
Removes a world handedness setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by DrawingAttributeKit.GetDefault().
- Returns
- A reference to this object.
The documentation for this class was generated from the following file:
- internals/hps_core/source/cs/HPS.DrawingAttributeControl.cs