CFx SDK Documentation 2024 SP0
|
#include <GiVisualStyle.h>
Public Types | |
enum | EdgeModel { kNoEdges = 0 , kIsolines = 1 , kFacetEdges = 2 } |
enum | EdgeStyle { kNoEdgeStyle = 0 , kVisible = 1 , kSilhouette = 2 , kObscured = 4 , kIntersection = 8 } |
enum | EdgeModifier { kNoEdgeModifiers = 0x000 , kOverhang = 0x001 , kJitter = 0x002 , kWidth = 0x004 , kColor = 0x008 , kHaloGap = 0x010 , kLinetype = 0x020 , kAlwaysOnTop = 0x040 , kOpacity = 0x080 , kWiggle = 0x100 , kTexture = 0x200 } |
enum | JitterAmount { kJitterLow = 1 , kJitterMedium = 2 , kJitterHigh = 3 } |
enum | WiggleAmount { kWiggleLow = 1 , kWiggleMedium = 2 , kWiggleHigh = 3 } |
enum | LineType { kSolid = 1 , kDashed = 2 , kDotted = 3 , kShortDash = 4 , kMediumDash = 5 , kLongDash = 6 , kDoubleShortDash = 7 , kDoubleMediumDash = 8 , kDoubleLongDash = 9 , kMediumLongDash = 10 , kSparseDot = 11 } |
enum | EdgeStyleApply { kDefault , kAll } |
Public Member Functions | |
ODRX_DECLARE_MEMBERS (OdGiEdgeStyle) | |
void | set (const OdGiEdgeStyle &style) |
OdGiEdgeStyle & | operator= (const OdGiEdgeStyle &style) |
bool | operator== (const OdGiEdgeStyle &style) const |
virtual void | setEdgeModel (EdgeModel model)=0 |
virtual EdgeModel | edgeModel () const =0 |
virtual void | setEdgeStyles (unsigned long nStyles)=0 |
virtual void | setEdgeStyleFlag (EdgeStyle flag, bool bEnable)=0 |
virtual unsigned long | edgeStyles () const =0 |
virtual bool | isEdgeStyleFlagSet (EdgeStyle flag) const =0 |
virtual void | setIntersectionColor (const OdCmColorBase &color)=0 |
virtual const OdCmColorBase & | intersectionColor () const =0 |
virtual OdCmColorBase & | intersectionColor ()=0 |
virtual void | setObscuredColor (const OdCmColorBase &color)=0 |
virtual const OdCmColorBase & | obscuredColor () const =0 |
virtual OdCmColorBase & | obscuredColor ()=0 |
virtual void | setObscuredLinetype (LineType ltype)=0 |
virtual LineType | obscuredLinetype () const =0 |
virtual void | setIntersectionLinetype (LineType ltype)=0 |
virtual LineType | intersectionLinetype () const =0 |
virtual void | setCreaseAngle (double nAngle)=0 |
virtual double | creaseAngle () const =0 |
virtual void | setEdgeModifiers (unsigned long nModifiers)=0 |
virtual void | setEdgeModifierFlag (EdgeModifier flag, bool bEnable)=0 |
virtual unsigned long | edgeModifiers () const =0 |
virtual bool | isEdgeModifierFlagSet (EdgeModifier flag) const =0 |
virtual void | setEdgeColor (const OdCmColorBase &color, bool bEnableModifier)=0 |
virtual const OdCmColorBase & | edgeColor () const =0 |
virtual OdCmColorBase & | edgeColor ()=0 |
virtual void | setOpacityLevel (double nLevel, bool bEnableModifier)=0 |
virtual double | opacityLevel () const =0 |
virtual void | setEdgeWidth (int nWidth, bool bEnableModifier)=0 |
virtual int | edgeWidth () const =0 |
virtual void | setOverhangAmount (int nAmount, bool bEnableModifier)=0 |
virtual int | overhangAmount () const =0 |
virtual void | setJitterAmount (JitterAmount amount, bool bEnableModifier)=0 |
virtual JitterAmount | jitterAmount () const =0 |
virtual void | setWiggleAmount (WiggleAmount amount, bool bEnableModifier)=0 |
virtual WiggleAmount | wiggleAmount () const =0 |
virtual void | setSilhouetteColor (const OdCmColorBase &color)=0 |
virtual const OdCmColorBase & | silhouetteColor () const =0 |
virtual OdCmColorBase & | silhouetteColor ()=0 |
virtual void | setSilhouetteWidth (short nWidth)=0 |
virtual short | silhouetteWidth () const =0 |
virtual void | setHaloGap (int nHaloGap, bool bEnableModifier)=0 |
virtual int | haloGap () const =0 |
virtual void | setIsolines (unsigned short nIsolines)=0 |
virtual unsigned short | isolines () const =0 |
virtual void | setHidePrecision (bool bHidePrecision)=0 |
virtual bool | hidePrecision () const =0 |
virtual void | setEdgeStyleApply (EdgeStyleApply apply)=0 |
virtual EdgeStyleApply | edgeStyleApply () const =0 |
Public Member Functions inherited from OdRxObject | |
ODRX_HEAP_OPERATORS () | |
OdRxObject () | |
virtual | ~OdRxObject () |
virtual OdRxObject * | queryX (const OdRxClass *pClass) const |
virtual OdRxObject * | x (const OdRxClass *pClass) const |
virtual OdRxClass * | isA () const |
virtual void | addRef ()=0 |
virtual void | release ()=0 |
virtual long | numRefs () const |
bool | isKindOf (const OdRxClass *pClass) const |
virtual OdRxObjectPtr | clone () const |
virtual void | copyFrom (const OdRxObject *pSource) |
virtual OdRx::Ordering | comparedTo (const OdRxObject *pOther) const |
virtual bool | isEqualTo (const OdRxObject *pOther) const |
Additional Inherited Members | |
Static Public Member Functions inherited from OdRxObject | |
static OdRxObjectPtr | cast (const OdRxObject *pointer) |
static OdRxClass * | desc () |
This class defines a set of visual style properties that can be applied to the edges of graphical entities.
Corresponding C++ library: TD_Gi <group OdGi_Classes>
Definition at line 246 of file GiVisualStyle.h.
Defines the model that is used to display the edges.
Enumerator | |
---|---|
kNoEdges | |
kIsolines | |
kFacetEdges |
Definition at line 254 of file GiVisualStyle.h.
Defines a collection of modifiers that can be applied to edges to give them various types of effects.
Enumerator | |
---|---|
kNoEdgeModifiers | |
kOverhang | |
kJitter | |
kWidth | |
kColor | |
kHaloGap | |
kLinetype | |
kAlwaysOnTop | |
kOpacity | |
kWiggle | |
kTexture |
Definition at line 276 of file GiVisualStyle.h.
Defines a collection of bitflags that represent the combination of edge styles that are in effect for displaying edges.
Enumerator | |
---|---|
kNoEdgeStyle | |
kVisible | |
kSilhouette | |
kObscured | |
kIntersection |
Definition at line 264 of file GiVisualStyle.h.
Defines the type of geometry to which the edge styles should be applied.
Enumerator | |
---|---|
kDefault | |
kAll |
Definition at line 332 of file GiVisualStyle.h.
Defines a collection of jitter values that can be applied to edges.
Enumerator | |
---|---|
kJitterLow | |
kJitterMedium | |
kJitterHigh |
Definition at line 294 of file GiVisualStyle.h.
Defines a collection of linetypes that can be applied to edges.
Enumerator | |
---|---|
kSolid | |
kDashed | |
kDotted | |
kShortDash | |
kMediumDash | |
kLongDash | |
kDoubleShortDash | |
kDoubleMediumDash | |
kDoubleLongDash | |
kMediumLongDash | |
kSparseDot |
Definition at line 314 of file GiVisualStyle.h.
Defines a collection of wiggle values that can be applied to edges.
Enumerator | |
---|---|
kWiggleLow | |
kWiggleMedium | |
kWiggleHigh |
Definition at line 304 of file GiVisualStyle.h.
|
pure virtual |
Returns the double value that is the angle threshold (in degrees) above which a facet edge representing adjoining facets will be displayed.
Implemented in OdGiVisualStyleDataContainer::OdGiEdgeStyleDataContainer.
|
pure virtual |
Returns the color of edges.
Implemented in OdGiVisualStyleDataContainer::OdGiEdgeStyleDataContainer.
|
pure virtual |
Returns the color of edges.
Implemented in OdGiVisualStyleDataContainer::OdGiEdgeStyleDataContainer.
|
pure virtual |
Returns the currently used edge model value for this OdGiEdgeStyle object. All model values are defined in the EdgeModel enumeration.
Implemented in OdGiVisualStyleDataContainer::OdGiEdgeStyleDataContainer.
|
pure virtual |
Returns the collection of currently used edge modifier flags.
Implemented in OdGiVisualStyleDataContainer::OdGiEdgeStyleDataContainer.
|
pure virtual |
Returns the type of geometry to which the edge style will be applied as an EdgeStyleApply value.
Implemented in OdGiVisualStyleDataContainer::OdGiEdgeStyleDataContainer.
|
pure virtual |
Returns an unsigned long value that represents a collection of edge style flags in effect.
Implemented in OdGiVisualStyleDataContainer::OdGiEdgeStyleDataContainer.
|
pure virtual |
Returns the edge width in pixels.
Implemented in OdGiVisualStyleDataContainer::OdGiEdgeStyleDataContainer.
|
pure virtual |
Returns the halo gap amount.
Implemented in OdGiVisualStyleDataContainer::OdGiEdgeStyleDataContainer.
|
pure virtual |
Checks whether hide precision is enabled.
Implemented in OdGiVisualStyleDataContainer::OdGiEdgeStyleDataContainer.
|
pure virtual |
Returns the color of intersection edges.
Implemented in OdGiVisualStyleDataContainer::OdGiEdgeStyleDataContainer.
|
pure virtual |
Returns the color of intersection edges.
Implemented in OdGiVisualStyleDataContainer::OdGiEdgeStyleDataContainer.
|
pure virtual |
Returns the linetype of intersection edges.
Implemented in OdGiVisualStyleDataContainer::OdGiEdgeStyleDataContainer.
|
pure virtual |
Returns whether the specified edge modifier flag is enabled.
flag | [in] Flag to be checked whether it's enabled or disabled. |
Implemented in OdGiVisualStyleDataContainer::OdGiEdgeStyleDataContainer.
|
pure virtual |
Returns whether the specified edge modifier flag is enabled.
flag | [in] Flag to be checked whether it's enabled or disabled. |
Implemented in OdGiVisualStyleDataContainer::OdGiEdgeStyleDataContainer.
|
pure virtual |
Returns the number of isolines.
Implemented in OdGiVisualStyleDataContainer::OdGiEdgeStyleDataContainer.
|
pure virtual |
Returns the amount of jitter effect as a JitterAmount value.
Implemented in OdGiVisualStyleDataContainer::OdGiEdgeStyleDataContainer.
|
pure virtual |
Returns the color of obscured edges.
Implemented in OdGiVisualStyleDataContainer::OdGiEdgeStyleDataContainer.
|
pure virtual |
Returns the color of obscured edges.
Implemented in OdGiVisualStyleDataContainer::OdGiEdgeStyleDataContainer.
|
pure virtual |
Returns the linetype of obscured edges.
Implemented in OdGiVisualStyleDataContainer::OdGiEdgeStyleDataContainer.
OdGiEdgeStyle::ODRX_DECLARE_MEMBERS | ( | OdGiEdgeStyle | ) |
|
pure virtual |
Returns the opacity level applied to edges.
Implemented in OdGiVisualStyleDataContainer::OdGiEdgeStyleDataContainer.
OdGiEdgeStyle & OdGiEdgeStyle::operator= | ( | const OdGiEdgeStyle & | style | ) |
Assignment operator for the OdGiEdgeStyle class. Returns reference to OdGiEdgeStyle object with assigned parameters.
style | [in] Edge style to assign. |
bool OdGiEdgeStyle::operator== | ( | const OdGiEdgeStyle & | style | ) | const |
Equality operator for the OdGiEdgeStyle class. Style properties are considered equal if: Edge models equal; Edge style flags are equal; Intersection colors are equal; Colors for obscured edges are equal; Linetypes for obscured edges are equal; Crease angles are equal; Edge colors are equal; Opacity levels are equal; Edge width values are equal; Overhang amount values are equal; Jitter values are equal; Wiggle amount values are equal; Silhouette colors are equal; Silhouette width values are equal; Halo gaps are equal; Isolines are equal; Hide precision values are equal; Types of geometry to which edge styles are applied must be the same; Intersection linetypes are equal; Edge modifier flags are equal;
style | [in] Edge style to compare. |
|
pure virtual |
Returns the edge overhang in pixels.
Implemented in OdGiVisualStyleDataContainer::OdGiEdgeStyleDataContainer.
void OdGiEdgeStyle::set | ( | const OdGiEdgeStyle & | style | ) |
Sets a specified edge style value for this OdGiEdgeStyle object.
style | [in] Reference to an OdGiEdgeStyle value to be copied into this edge style. |
|
pure virtual |
Sets the angle threshold, above which a facet edge representing adjoining facets will be displayed.
nAngle | [in] Threshold angle to set. |
Implemented in OdGiVisualStyleDataContainer::OdGiEdgeStyleDataContainer.
|
pure virtual |
Sets the color of edges.
color | [in] Color value to set. |
bEnableModifier | [in] Value that indicates whether to enable or disable the color. |
Implemented in OdGiVisualStyleDataContainer::OdGiEdgeStyleDataContainer.
Sets a specified edge model value for this OdGiEdgeStyle object.
model | [in] Edge model value to set. All available values are defined in the EdgeModel enum. |
Implemented in OdGiVisualStyleDataContainer::OdGiEdgeStyleDataContainer.
|
pure virtual |
Enables or disables the specified edge modifier flag.
flag | [in] Flag to enable or disable. |
bEnable | [in] Value that indicates whether to enable or disable the specified flag. |
Implemented in OdGiVisualStyleDataContainer::OdGiEdgeStyleDataContainer.
|
pure virtual |
Sets a collection of bitflags representing the edge modifiers in effect.
nModifiers | [in] Unsigned long value that represents a collection of bitwise flags defined in the EdgeModifier enumeration. |
Implemented in OdGiVisualStyleDataContainer::OdGiEdgeStyleDataContainer.
|
pure virtual |
Sets a type to what geometry the edge style should be applied.
apply | [in] Value that represents the type of geometry to which the edge styles should be applied. |
Implemented in OdGiVisualStyleDataContainer::OdGiEdgeStyleDataContainer.
Enables or disables the given edge styles flag.
flag | [in] A flag to enable or disable. |
bEnable | [in] A boolean value indicating if the given flag is to be enabled or disabled. |
Implemented in OdGiVisualStyleDataContainer::OdGiEdgeStyleDataContainer.
|
pure virtual |
Sets a combination of values from the EdgeStyle enumeration as an edge styles value for this OdGiEdgeStyle object.
nStyles | [in] A combination of bit flags from the EdgeStyle enumeration indicating desired edge styles. |
Implemented in OdGiVisualStyleDataContainer::OdGiEdgeStyleDataContainer.
|
pure virtual |
Sets the edge width in pixels.
nWidth | [in] The width to set. |
bEnableModifier | [in] Value that indicates whether to enable or disable the edge width. |
Implemented in OdGiVisualStyleDataContainer::OdGiEdgeStyleDataContainer.
|
pure virtual |
Sets the amount of halo gap.
nHaloGap | [in] The halo gap amount to set. Value must be from 0 to 100. |
bEnableModifier | [in] Value that indicates whether to enable or disable halo gap. |
Implemented in OdGiVisualStyleDataContainer::OdGiEdgeStyleDataContainer.
|
pure virtual |
Sets whether hide precision should be enabled.
bHidePrecision | [in] Value that indicates whether to enable or disable hide precision. |
Implemented in OdGiVisualStyleDataContainer::OdGiEdgeStyleDataContainer.
|
pure virtual |
Sets the color of intersection edges.
color | [in] Intersection edges color to set. |
Implemented in OdGiVisualStyleDataContainer::OdGiEdgeStyleDataContainer.
Sets the linetype of intersection edges.
ltype | [in] Intersection edges linetype to set. |
Implemented in OdGiVisualStyleDataContainer::OdGiEdgeStyleDataContainer.
|
pure virtual |
Sets the number of isolines.
nIsolines | [in] The number of isolines to set. Value must be between 0 and 2047. |
Implemented in OdGiVisualStyleDataContainer::OdGiEdgeStyleDataContainer.
|
pure virtual |
Sets the amount of jitter effect to be applied to jittered edges.
amount | [in] The jitter amount to set. All applicable values are defined in the JitterAmount enumeration. |
bEnableModifier | [in] Value that indicates whether to enable or disable jitter effect. |
Implemented in OdGiVisualStyleDataContainer::OdGiEdgeStyleDataContainer.
|
pure virtual |
Sets the color of obscured edges.
color | [in] Obscured edges color to set. |
Implemented in OdGiVisualStyleDataContainer::OdGiEdgeStyleDataContainer.
Sets the linetype of obscured edges.
ltype | [in] Obscured edges linetype to set. |
Implemented in OdGiVisualStyleDataContainer::OdGiEdgeStyleDataContainer.
|
pure virtual |
Sets the opacity level of edges.
nLevel | [in] Opacity level to set. Must be in the range from 0.0 (edges are fully transparent) to 1.0 (no transparency). |
bEnableModifier | [in] Value that indicates whether to enable or disable the opacity. |
Implemented in OdGiVisualStyleDataContainer::OdGiEdgeStyleDataContainer.
|
pure virtual |
Sets the amount (in pixels) that edges should overhang their start and end points.
nAmount | [in] The overhang amount. |
bEnableModifier | [in] Value that indicates whether to enable or disable edge overhang. |
Implemented in OdGiVisualStyleDataContainer::OdGiEdgeStyleDataContainer.
|
pure virtual |
Sets the color of silhouette edges.
color | [in] Reference to an OdCmColorBase value to set. |
Implemented in OdGiVisualStyleDataContainer::OdGiEdgeStyleDataContainer.
|
pure virtual |
Sets the width of silhouette edges.
nWidth | [in] Width of silhouette edges (in pixels) to set. |
Implemented in OdGiVisualStyleDataContainer::OdGiEdgeStyleDataContainer.
|
pure virtual |
Sets the amount of wiggle effect to be applied to edges.
amount | [in] The wiggle amount to set. All applicable values are defined in the WiggleAmount enumeration. |
bEnableModifier | [in] Value that indicates whether to enable or disable wiggle effect. |
Implemented in OdGiVisualStyleDataContainer::OdGiEdgeStyleDataContainer.
|
pure virtual |
Returns the silhouette color.
Implemented in OdGiVisualStyleDataContainer::OdGiEdgeStyleDataContainer.
|
pure virtual |
Returns the silhouette color.
Implemented in OdGiVisualStyleDataContainer::OdGiEdgeStyleDataContainer.
|
pure virtual |
Returns the width of silhouette edges in pixels.
Implemented in OdGiVisualStyleDataContainer::OdGiEdgeStyleDataContainer.
|
pure virtual |
Returns the amount of wiggle effect as a WiggleAmount value.
Implemented in OdGiVisualStyleDataContainer::OdGiEdgeStyleDataContainer.