Open CASCADE Technology 7.8.0
Public Member Functions
AIS_ColoredDrawer Class Reference

Customizable properties. More...

#include <AIS_ColoredDrawer.hxx>

Inheritance diagram for AIS_ColoredDrawer:
Inheritance graph
[legend]

Public Member Functions

 AIS_ColoredDrawer (const Handle< Prs3d_Drawer > &theLink)
 Default constructor.
 
bool IsHidden () const
 
void SetHidden (const bool theToHide)
 
bool HasOwnMaterial () const
 
void UnsetOwnMaterial ()
 
void SetOwnMaterial ()
 
bool HasOwnColor () const
 
void UnsetOwnColor ()
 
void SetOwnColor (const Quantity_Color &)
 
bool HasOwnTransparency () const
 
void UnsetOwnTransparency ()
 
void SetOwnTransparency (Standard_Real)
 
bool HasOwnWidth () const
 
void UnsetOwnWidth ()
 
void SetOwnWidth (const Standard_Real)
 
- Public Member Functions inherited from Prs3d_Drawer
 Prs3d_Drawer ()
 Default constructor.
 
void SetupOwnDefaults ()
 Setup all own aspects with default values.
 
void SetTypeOfDeflection (const Aspect_TypeOfDeflection theTypeOfDeflection)
 Sets the type of chordal deflection. This indicates whether the deflection value is absolute or relative to the size of the object.
 
Aspect_TypeOfDeflection TypeOfDeflection () const
 Returns the type of chordal deflection. This indicates whether the deflection value is absolute or relative to the size of the object.
 
Standard_Boolean HasOwnTypeOfDeflection () const
 Returns true if the drawer has a type of deflection setting active.
 
void UnsetOwnTypeOfDeflection ()
 Resets HasOwnTypeOfDeflection() flag, e.g. undoes SetTypeOfDeflection().
 
void SetMaximalChordialDeviation (const Standard_Real theChordialDeviation)
 Defines the maximal chordial deviation when drawing any curve. Even if the type of deviation is set to TOD_Relative, this value is used by: Prs3d_DeflectionCurve Prs3d_WFDeflectionSurface Prs3d_WFDeflectionRestrictedFace.
 
Standard_Real MaximalChordialDeviation () const
 Returns the maximal chordal deviation. The default value is 0.0001. Drawings of curves or patches are made with respect to an absolute maximal chordal deviation.
 
Standard_Boolean HasOwnMaximalChordialDeviation () const
 Returns true if the drawer has a maximal chordial deviation setting active.
 
void UnsetOwnMaximalChordialDeviation ()
 Resets HasOwnMaximalChordialDeviation() flag, e.g. undoes SetMaximalChordialDeviation().
 
void SetTypeOfHLR (const Prs3d_TypeOfHLR theTypeOfHLR)
 Sets the type of HLR algorithm used by drawer's interactive objects.
 
Prs3d_TypeOfHLR TypeOfHLR () const
 Returns the type of HLR algorithm currently in use.
 
Standard_Boolean HasOwnTypeOfHLR () const
 Returns true if the type of HLR is not equal to Prs3d_TOH_NotSet.
 
void SetMaximalParameterValue (const Standard_Real theValue)
 Defines the maximum value allowed for the first and last parameters of an infinite curve.
 
Standard_Real MaximalParameterValue () const
 Sets the maximum value allowed for the first and last parameters of an infinite curve. By default, this value is 500000.
 
Standard_Boolean HasOwnMaximalParameterValue () const
 Returns true if the drawer has a maximum value allowed for the first and last parameters of an infinite curve setting active.
 
void UnsetOwnMaximalParameterValue ()
 Resets HasOwnMaximalParameterValue() flag, e.g. undoes SetMaximalParameterValue().
 
void SetIsoOnPlane (const Standard_Boolean theIsEnabled)
 Sets IsoOnPlane on or off by setting the parameter theIsEnabled to true or false.
 
Standard_Boolean IsoOnPlane () const
 Returns True if the drawing of isos on planes is enabled.
 
Standard_Boolean HasOwnIsoOnPlane () const
 Returns true if the drawer has IsoOnPlane setting active.
 
void UnsetOwnIsoOnPlane ()
 Resets HasOwnIsoOnPlane() flag, e.g. undoes SetIsoOnPlane().
 
Standard_Boolean IsoOnTriangulation () const
 Returns True if the drawing of isos on triangulation is enabled.
 
Standard_Boolean HasOwnIsoOnTriangulation () const
 Returns true if the drawer has IsoOnTriangulation setting active.
 
void UnsetOwnIsoOnTriangulation ()
 Resets HasOwnIsoOnTriangulation() flag, e.g. undoes SetIsoOnTriangulation().
 
void SetIsoOnTriangulation (const Standard_Boolean theToEnable)
 Enables or disables isolines on triangulation by setting the parameter theIsEnabled to true or false.
 
void SetDiscretisation (const Standard_Integer theValue)
 Sets the discretisation parameter theValue.
 
Standard_Integer Discretisation () const
 Returns the discretisation setting.
 
Standard_Boolean HasOwnDiscretisation () const
 Returns true if the drawer has discretisation setting active.
 
void UnsetOwnDiscretisation ()
 Resets HasOwnDiscretisation() flag, e.g. undoes SetDiscretisation().
 
void SetDeviationCoefficient (const Standard_Real theCoefficient)
 Sets the deviation coefficient theCoefficient. Also sets the hasOwnDeviationCoefficient flag to Standard_True and myPreviousDeviationCoefficient.
 
Standard_Real DeviationCoefficient () const
 Returns the deviation coefficient. Drawings of curves or patches are made with respect to a maximal chordal deviation. A Deviation coefficient is used in the shading display mode. The shape is seen decomposed into triangles. These are used to calculate reflection of light from the surface of the object. The triangles are formed from chords of the curves in the shape. The deviation coefficient gives the highest value of the angle with which a chord can deviate from a tangent to a curve. If this limit is reached, a new triangle is begun. This deviation is absolute and is set through the method: SetMaximalChordialDeviation. The default value is 0.001. In drawing shapes, however, you are allowed to ask for a relative deviation. This deviation will be: SizeOfObject * DeviationCoefficient.
 
void SetDeviationCoefficient ()
 Resets HasOwnDeviationCoefficient() flag, e.g. undoes previous SetDeviationCoefficient().
 
Standard_Boolean HasOwnDeviationCoefficient () const
 Returns true if there is a local setting for deviation coefficient in this framework for a specific interactive object.
 
Standard_Real PreviousDeviationCoefficient () const
 Saves the previous value used for the chordal deviation coefficient.
 
void UpdatePreviousDeviationCoefficient ()
 Updates the previous value used for the chordal deviation coefficient to the current state.
 
void SetDeviationAngle (const Standard_Real theAngle)
 Sets the deviation angle theAngle. Also sets the hasOwnDeviationAngle flag to Standard_True, and myPreviousDeviationAngle.
 
Standard_Real DeviationAngle () const
 Returns the value for deviation angle in radians, 20 * M_PI / 180 by default.
 
void SetDeviationAngle ()
 Resets HasOwnDeviationAngle() flag, e.g. undoes previous SetDeviationAngle().
 
Standard_Boolean HasOwnDeviationAngle () const
 Returns true if there is a local setting for deviation angle in this framework for a specific interactive object.
 
Standard_Real PreviousDeviationAngle () const
 Returns the previous deviation angle.
 
void UpdatePreviousDeviationAngle ()
 Updates the previous deviation angle to the current value.
 
void SetAutoTriangulation (const Standard_Boolean theIsEnabled)
 Sets IsAutoTriangulated on or off by setting the parameter theIsEnabled to true or false. If this flag is True automatic re-triangulation with deflection-check logic will be applied. Else this feature will be disable and triangulation is expected to be computed by application itself and no shading presentation at all if unavailable.
 
Standard_Boolean IsAutoTriangulation () const
 Returns True if automatic triangulation is enabled.
 
Standard_Boolean HasOwnIsAutoTriangulation () const
 Returns true if the drawer has IsoOnPlane setting active.
 
void UnsetOwnIsAutoTriangulation ()
 Resets HasOwnIsAutoTriangulation() flag, e.g. undoes SetAutoTriangulation().
 
const Handle< Prs3d_IsoAspect > & UIsoAspect () const
 Defines own attributes for drawing an U isoparametric curve of a face, settings from linked Drawer or NULL if neither was set.
 
void SetUIsoAspect (const Handle< Prs3d_IsoAspect > &theAspect)
 
Standard_Boolean HasOwnUIsoAspect () const
 Returns true if the drawer has its own attribute for UIso aspect that overrides the one in the link.
 
const Handle< Prs3d_IsoAspect > & VIsoAspect () const
 Defines own attributes for drawing an V isoparametric curve of a face, settings from linked Drawer or NULL if neither was set.
 
void SetVIsoAspect (const Handle< Prs3d_IsoAspect > &theAspect)
 Sets the appearance of V isoparameters - theAspect.
 
Standard_Boolean HasOwnVIsoAspect () const
 Returns true if the drawer has its own attribute for VIso aspect that overrides the one in the link.
 
const Handle< Prs3d_LineAspect > & WireAspect () const
 Returns own wire aspect settings, settings from linked Drawer or NULL if neither was set. These attributes are used by the algorithm Prs3d_WFShape.
 
void SetWireAspect (const Handle< Prs3d_LineAspect > &theAspect)
 Sets the parameter theAspect for display of wires.
 
Standard_Boolean HasOwnWireAspect () const
 Returns true if the drawer has its own attribute for wire aspect that overrides the one in the link.
 
void SetWireDraw (const Standard_Boolean theIsEnabled)
 Sets WireDraw on or off by setting the parameter theIsEnabled to true or false.
 
Standard_Boolean WireDraw () const
 Returns True if the drawing of the wire is enabled.
 
Standard_Boolean HasOwnWireDraw () const
 Returns true if the drawer has its own attribute for "draw wires" flag that overrides the one in the link.
 
void UnsetOwnWireDraw ()
 Resets HasOwnWireDraw() flag, e.g. undoes SetWireDraw().
 
const Handle< Prs3d_PointAspect > & PointAspect () const
 Returns own point aspect setting, settings from linked Drawer or NULL if neither was set. These attributes are used by the algorithms Prs3d_Point.
 
void SetPointAspect (const Handle< Prs3d_PointAspect > &theAspect)
 Sets the parameter theAspect for display attributes of points.
 
Standard_Boolean HasOwnPointAspect () const
 Returns true if the drawer has its own attribute for point aspect that overrides the one in the link.
 
Standard_Boolean SetupOwnPointAspect (const Handle< Prs3d_Drawer > &theDefaults=Handle< Prs3d_Drawer >())
 Sets own point aspect, which is a yellow Aspect_TOM_PLUS marker by default. Returns FALSE if the drawer already has its own attribute for point aspect.
 
const Handle< Prs3d_LineAspect > & LineAspect () const
 Returns own settings for line aspects, settings from linked Drawer or NULL if neither was set. These attributes are used by the following algorithms: Prs3d_Curve Prs3d_Line Prs3d_HLRShape.
 
void SetLineAspect (const Handle< Prs3d_LineAspect > &theAspect)
 Sets the parameter theAspect for display attributes of lines.
 
Standard_Boolean HasOwnLineAspect () const
 Returns true if the drawer has its own attribute for line aspect that overrides the one in the link.
 
Standard_Boolean SetOwnLineAspects (const Handle< Prs3d_Drawer > &theDefaults=Handle< Prs3d_Drawer >())
 Sets own line aspects, which are single U and single V gray75 solid isolines (UIsoAspect(), VIsoAspect()), red wire (WireAspect()), yellow line (LineAspect()), yellow seen line (SeenLineAspect()), dashed yellow hidden line (HiddenLineAspect()), green free boundary (FreeBoundaryAspect()), yellow unfree boundary (UnFreeBoundaryAspect()). Returns FALSE if own line aspect are already set.
 
Standard_Boolean SetOwnDatumAspects (const Handle< Prs3d_Drawer > &theDefaults=Handle< Prs3d_Drawer >())
 Sets own line aspects for datums. Returns FALSE if own line for datums are already set.
 
const Handle< Prs3d_TextAspect > & TextAspect () const
 Returns own settings for text aspect, settings from linked Drawer or NULL if neither was set.
 
void SetTextAspect (const Handle< Prs3d_TextAspect > &theAspect)
 Sets the parameter theAspect for display attributes of text.
 
Standard_Boolean HasOwnTextAspect () const
 Returns true if the drawer has its own attribute for text aspect that overrides the one in the link.
 
const Handle< Prs3d_ShadingAspect > & ShadingAspect () const
 Returns own settings for shading aspects, settings from linked Drawer or NULL if neither was set.
 
void SetShadingAspect (const Handle< Prs3d_ShadingAspect > &theAspect)
 Sets the parameter theAspect for display attributes of shading.
 
Standard_Boolean HasOwnShadingAspect () const
 Returns true if the drawer has its own attribute for shading aspect that overrides the one in the link.
 
Standard_Boolean SetupOwnShadingAspect (const Handle< Prs3d_Drawer > &theDefaults=Handle< Prs3d_Drawer >())
 Sets own shading aspect, which is Graphic3d_NameOfMaterial_Brass material by default. Returns FALSE if the drawer already has its own attribute for shading aspect.
 
const Handle< Prs3d_LineAspect > & SeenLineAspect () const
 Returns own settings for seen line aspects, settings of linked Drawer or NULL if neither was set.
 
void SetSeenLineAspect (const Handle< Prs3d_LineAspect > &theAspect)
 Sets the parameter theAspect for the display of seen lines in hidden line removal mode.
 
Standard_Boolean HasOwnSeenLineAspect () const
 Returns true if the drawer has its own attribute for seen line aspect that overrides the one in the link.
 
const Handle< Prs3d_PlaneAspect > & PlaneAspect () const
 Returns own settings for the appearance of planes, settings from linked Drawer or NULL if neither was set.
 
void SetPlaneAspect (const Handle< Prs3d_PlaneAspect > &theAspect)
 Sets the parameter theAspect for the display of planes.
 
Standard_Boolean HasOwnPlaneAspect () const
 Returns true if the drawer has its own attribute for plane aspect that overrides the one in the link.
 
const Handle< Prs3d_ArrowAspect > & ArrowAspect () const
 Returns own attributes for display of arrows, settings from linked Drawer or NULL if neither was set.
 
void SetArrowAspect (const Handle< Prs3d_ArrowAspect > &theAspect)
 Sets the parameter theAspect for display attributes of arrows.
 
Standard_Boolean HasOwnArrowAspect () const
 Returns true if the drawer has its own attribute for arrow aspect that overrides the one in the link.
 
void SetLineArrowDraw (const Standard_Boolean theIsEnabled)
 Enables the drawing of an arrow at the end of each line. By default the arrows are not drawn.
 
Standard_Boolean LineArrowDraw () const
 Returns True if drawing an arrow at the end of each edge is enabled and False otherwise (the default).
 
Standard_Boolean HasOwnLineArrowDraw () const
 Returns true if the drawer has its own attribute for "draw arrow" flag that overrides the one in the link.
 
void UnsetOwnLineArrowDraw ()
 Reset HasOwnLineArrowDraw() flag, e.g. undoes SetLineArrowDraw().
 
const Handle< Prs3d_LineAspect > & HiddenLineAspect () const
 Returns own settings for hidden line aspects, settings from linked Drawer or NULL if neither was set.
 
void SetHiddenLineAspect (const Handle< Prs3d_LineAspect > &theAspect)
 Sets the parameter theAspect for the display of hidden lines in hidden line removal mode.
 
Standard_Boolean HasOwnHiddenLineAspect () const
 Returns true if the drawer has its own attribute for hidden lines aspect that overrides the one in the link.
 
Standard_Boolean DrawHiddenLine () const
 Returns Standard_True if the hidden lines are to be drawn. By default the hidden lines are not drawn.
 
void EnableDrawHiddenLine ()
 Enables the DrawHiddenLine function.
 
void DisableDrawHiddenLine ()
 Disables the DrawHiddenLine function.
 
Standard_Boolean HasOwnDrawHiddenLine () const
 Returns true if the drawer has its own attribute for "draw hidden lines" flag that overrides the one in the link.
 
void UnsetOwnDrawHiddenLine ()
 Resets HasOwnDrawHiddenLine() flag, e.g. unsets EnableDrawHiddenLine()/DisableDrawHiddenLine().
 
const Handle< Prs3d_LineAspect > & VectorAspect () const
 Returns own settings for the appearance of vectors, settings from linked Drawer or NULL if neither was set.
 
void SetVectorAspect (const Handle< Prs3d_LineAspect > &theAspect)
 Sets the modality theAspect for the display of vectors.
 
Standard_Boolean HasOwnVectorAspect () const
 Returns true if the drawer has its own attribute for vector aspect that overrides the one in the link.
 
void SetVertexDrawMode (const Prs3d_VertexDrawMode theMode)
 Sets the mode of visualization of vertices of a TopoDS_Shape instance. By default, only stand-alone vertices (not belonging topologically to an edge) are drawn, that corresponds to Prs3d_VDM_Standalone mode. Switching to Prs3d_VDM_Standalone mode makes all shape's vertices visible. To inherit this parameter from the global drawer instance ("the link") when it is present, Prs3d_VDM_Inherited value should be used.
 
Prs3d_VertexDrawMode VertexDrawMode () const
 Returns the current mode of visualization of vertices of a TopoDS_Shape instance.
 
Standard_Boolean HasOwnVertexDrawMode () const
 Returns true if the vertex draw mode is not equal to Prs3d_VDM_Inherited. This means that individual vertex draw mode value (i.e. not inherited from the global drawer) is used for a specific interactive object.
 
const Handle< Prs3d_DatumAspect > & DatumAspect () const
 Returns own settings for the appearance of datums, settings from linked Drawer or NULL if neither was set.
 
void SetDatumAspect (const Handle< Prs3d_DatumAspect > &theAspect)
 Sets the modality theAspect for the display of datums.
 
Standard_Boolean HasOwnDatumAspect () const
 Returns true if the drawer has its own attribute for datum aspect that overrides the one in the link.
 
const Handle< Prs3d_LineAspect > & SectionAspect () const
 Returns own LineAspect for section wire, settings from linked Drawer or NULL if neither was set. These attributes are used by the algorithm Prs3d_WFShape.
 
void SetSectionAspect (const Handle< Prs3d_LineAspect > &theAspect)
 Sets the parameter theAspect for display attributes of sections.
 
Standard_Boolean HasOwnSectionAspect () const
 Returns true if the drawer has its own attribute for section aspect that overrides the one in the link.
 
void SetFreeBoundaryAspect (const Handle< Prs3d_LineAspect > &theAspect)
 Sets the parameter theAspect for the display of free boundaries. The method sets aspect owned by the drawer that will be used during visualization instead of the one set in link.
 
const Handle< Prs3d_LineAspect > & FreeBoundaryAspect () const
 Returns own settings for presentation of free boundaries, settings from linked Drawer or NULL if neither was set. In other words, this settings affect boundaries which are not shared. These attributes are used by the algorithm Prs3d_WFShape.
 
Standard_Boolean HasOwnFreeBoundaryAspect () const
 Returns true if the drawer has its own attribute for free boundaries aspect that overrides the one in the link.
 
void SetFreeBoundaryDraw (const Standard_Boolean theIsEnabled)
 Enables or disables drawing of free boundaries for shading presentations. The method sets drawing flag owned by the drawer that will be used during visualization instead of the one set in link. theIsEnabled is a boolean flag indicating whether the free boundaries should be drawn or not.
 
Standard_Boolean FreeBoundaryDraw () const
 Returns True if the drawing of the free boundaries is enabled True is the default setting.
 
Standard_Boolean HasOwnFreeBoundaryDraw () const
 Returns true if the drawer has its own attribute for "draw free boundaries" flag that overrides the one in the link.
 
void UnsetOwnFreeBoundaryDraw ()
 Resets HasOwnFreeBoundaryDraw() flag, e.g. undoes SetFreeBoundaryDraw().
 
void SetUnFreeBoundaryAspect (const Handle< Prs3d_LineAspect > &theAspect)
 Sets the parameter theAspect for the display of shared boundaries. The method sets aspect owned by the drawer that will be used during visualization instead of the one set in link.
 
const Handle< Prs3d_LineAspect > & UnFreeBoundaryAspect () const
 Returns own settings for shared boundary line aspects, settings from linked Drawer or NULL if neither was set. These attributes are used by the algorithm Prs3d_WFShape.
 
Standard_Boolean HasOwnUnFreeBoundaryAspect () const
 Returns true if the drawer has its own attribute for unfree boundaries aspect that overrides the one in the link.
 
void SetUnFreeBoundaryDraw (const Standard_Boolean theIsEnabled)
 Enables or disables drawing of shared boundaries for shading presentations. The method sets drawing flag owned by the drawer that will be used during visualization instead of the one set in link. theIsEnabled is a boolean flag indicating whether the shared boundaries should be drawn or not.
 
Standard_Boolean UnFreeBoundaryDraw () const
 Returns True if the drawing of the shared boundaries is enabled. True is the default setting.
 
Standard_Boolean HasOwnUnFreeBoundaryDraw () const
 Returns true if the drawer has its own attribute for "draw shared boundaries" flag that overrides the one in the link.
 
void UnsetOwnUnFreeBoundaryDraw ()
 Resets HasOwnUnFreeBoundaryDraw() flag, e.g. undoes SetUnFreeBoundaryDraw().
 
void SetFaceBoundaryAspect (const Handle< Prs3d_LineAspect > &theAspect)
 Sets line aspect for face boundaries. The method sets line aspect owned by the drawer that will be used during visualization instead of the one set in link. theAspect is the line aspect that determines the look of the face boundaries.
 
const Handle< Prs3d_LineAspect > & FaceBoundaryAspect () const
 Returns own line aspect of face boundaries, settings from linked Drawer or NULL if neither was set.
 
Standard_Boolean HasOwnFaceBoundaryAspect () const
 Returns true if the drawer has its own attribute for face boundaries aspect that overrides the one in the link.
 
Standard_Boolean SetupOwnFaceBoundaryAspect (const Handle< Prs3d_Drawer > &theDefaults=Handle< Prs3d_Drawer >())
 Sets own face boundary aspect, which is a black solid line by default. Returns FALSE if the drawer already has its own attribute for face boundary aspect.
 
void SetFaceBoundaryDraw (const Standard_Boolean theIsEnabled)
 Enables or disables face boundary drawing for shading presentations. The method sets drawing flag owned by the drawer that will be used during visualization instead of the one set in link. theIsEnabled is a boolean flag indicating whether the face boundaries should be drawn or not.
 
Standard_Boolean FaceBoundaryDraw () const
 Checks whether the face boundary drawing is enabled or not.
 
Standard_Boolean HasOwnFaceBoundaryDraw () const
 Returns true if the drawer has its own attribute for "draw face boundaries" flag that overrides the one in the link.
 
void UnsetOwnFaceBoundaryDraw ()
 Resets HasOwnFaceBoundaryDraw() flag, e.g. undoes SetFaceBoundaryDraw().
 
Standard_Boolean HasOwnFaceBoundaryUpperContinuity () const
 Returns true if the drawer has its own attribute for face boundaries upper edge continuity class that overrides the one in the link.
 
GeomAbs_Shape FaceBoundaryUpperContinuity () const
 Get the most edge continuity class; GeomAbs_CN by default (all edges).
 
void SetFaceBoundaryUpperContinuity (GeomAbs_Shape theMostAllowedEdgeClass)
 Set the most edge continuity class for face boundaries.
 
void UnsetFaceBoundaryUpperContinuity ()
 Unset the most edge continuity class for face boundaries.
 
const Handle< Prs3d_DimensionAspect > & DimensionAspect () const
 Returns own settings for the appearance of dimensions, settings from linked Drawer or NULL if neither was set.
 
void SetDimensionAspect (const Handle< Prs3d_DimensionAspect > &theAspect)
 Sets the settings for the appearance of dimensions. The method sets aspect owned by the drawer that will be used during visualization instead of the one set in link.
 
Standard_Boolean HasOwnDimensionAspect () const
 Returns true if the drawer has its own attribute for the appearance of dimensions that overrides the one in the link.
 
void SetDimLengthModelUnits (const TCollection_AsciiString &theUnits)
 Sets dimension length model units for computing of dimension presentation. The method sets value owned by the drawer that will be used during visualization instead of the one set in link.
 
void SetDimAngleModelUnits (const TCollection_AsciiString &theUnits)
 Sets dimension angle model units for computing of dimension presentation. The method sets value owned by the drawer that will be used during visualization instead of the one set in link.
 
const TCollection_AsciiStringDimLengthModelUnits () const
 Returns length model units for the dimension presentation.
 
const TCollection_AsciiStringDimAngleModelUnits () const
 Returns angle model units for the dimension presentation.
 
Standard_Boolean HasOwnDimLengthModelUnits () const
 Returns true if the drawer has its own attribute for dimension length model units that overrides the one in the link.
 
void UnsetOwnDimLengthModelUnits ()
 Resets HasOwnDimLengthModelUnits() flag, e.g. undoes SetDimLengthModelUnits().
 
Standard_Boolean HasOwnDimAngleModelUnits () const
 Returns true if the drawer has its own attribute for dimension angle model units that overrides the one in the link.
 
void UnsetOwnDimAngleModelUnits ()
 Resets HasOwnDimAngleModelUnits() flag, e.g. undoes SetDimAngleModelUnits().
 
void SetDimLengthDisplayUnits (const TCollection_AsciiString &theUnits)
 Sets length units in which value for dimension presentation is displayed. The method sets value owned by the drawer that will be used during visualization instead of the one set in link.
 
void SetDimAngleDisplayUnits (const TCollection_AsciiString &theUnits)
 Sets angle units in which value for dimension presentation is displayed. The method sets value owned by the drawer that will be used during visualization instead of the one set in link.
 
const TCollection_AsciiStringDimLengthDisplayUnits () const
 Returns length units in which dimension presentation is displayed.
 
const TCollection_AsciiStringDimAngleDisplayUnits () const
 Returns angle units in which dimension presentation is displayed.
 
Standard_Boolean HasOwnDimLengthDisplayUnits () const
 Returns true if the drawer has its own attribute for length units in which dimension presentation is displayed that overrides the one in the link.
 
void UnsetOwnDimLengthDisplayUnits ()
 Resets HasOwnDimLengthModelUnits() flag, e.g. undoes SetDimLengthDisplayUnits().
 
Standard_Boolean HasOwnDimAngleDisplayUnits () const
 Returns true if the drawer has its own attribute for angle units in which dimension presentation is displayed that overrides the one in the link.
 
void UnsetOwnDimAngleDisplayUnits ()
 Resets HasOwnDimAngleDisplayUnits() flag, e.g. undoes SetDimLengthDisplayUnits().
 
const Handle< Prs3d_Drawer > & Link () const
 Returns the drawer to which the current object references.
 
Standard_Boolean HasLink () const
 Returns true if the current object has a link on the other drawer.
 
void Link (const Handle< Prs3d_Drawer > &theDrawer)
 Sets theDrawer as a link to which the current object references.
 
void SetLink (const Handle< Prs3d_Drawer > &theDrawer)
 Sets theDrawer as a link to which the current object references.
 
void ClearLocalAttributes ()
 Removes local attributes.
 
bool SetShaderProgram (const Handle< Graphic3d_ShaderProgram > &theProgram, const Graphic3d_GroupAspect theAspect, const bool theToOverrideDefaults=false)
 Assign shader program for specified type of primitives.
 
bool SetShadingModel (Graphic3d_TypeOfShadingModel theModel, bool theToOverrideDefaults=false)
 Sets Shading Model type for the shading aspect.
 
virtual void DumpJson (Standard_OStream &theOStream, Standard_Integer theDepth=-1) const override
 Dumps the content of me into the stream.
 
void SetHLRAngle (const Standard_Real theAngle)
 
Standard_Real HLRAngle () const
 
void SetHLRAngle ()
 
Standard_Boolean HasOwnHLRDeviationAngle () const
 
Standard_Real PreviousHLRDeviationAngle () const
 
- Public Member Functions inherited from Graphic3d_PresentationAttributes
 Graphic3d_PresentationAttributes ()
 Empty constructor.
 
virtual ~Graphic3d_PresentationAttributes ()
 Destructor.
 
Aspect_TypeOfHighlightMethod Method () const
 Returns highlight method, Aspect_TOHM_COLOR by default.
 
virtual void SetMethod (const Aspect_TypeOfHighlightMethod theMethod)
 Changes highlight method to the given one.
 
const Quantity_ColorRGBAColorRGBA () const
 Returns basic presentation color (including alpha channel).
 
const Quantity_ColorColor () const
 Returns basic presentation color, Quantity_NOC_WHITE by default.
 
virtual void SetColor (const Quantity_Color &theColor)
 Sets basic presentation color (RGB components, does not modifies transparency).
 
Standard_ShortReal Transparency () const
 Returns basic presentation transparency (0 - opaque, 1 - fully transparent), 0 by default (opaque).
 
virtual void SetTransparency (const Standard_ShortReal theTranspCoef)
 Sets basic presentation transparency (0 - opaque, 1 - fully transparent).
 
Graphic3d_ZLayerId ZLayer () const
 Returns presentation Zlayer, Graphic3d_ZLayerId_Default by default. Graphic3d_ZLayerId_UNKNOWN means undefined (a layer of main presentation to be used).
 
virtual void SetZLayer (const Graphic3d_ZLayerId theLayer)
 Sets presentation Zlayer.
 
Standard_Integer DisplayMode () const
 Returns display mode, 0 by default. -1 means undefined (main display mode of presentation to be used).
 
virtual void SetDisplayMode (const Standard_Integer theMode)
 Sets display mode.
 
const Handle< Graphic3d_AspectFillArea3d > & BasicFillAreaAspect () const
 Return basic presentation fill area aspect, NULL by default. When set, might be used instead of Color() property.
 
virtual void SetBasicFillAreaAspect (const Handle< Graphic3d_AspectFillArea3d > &theAspect)
 Sets basic presentation fill area aspect.
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor.
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing.
 
Standard_Transientoperator= (const Standard_Transient &)
 Assignment operator, needed to avoid copying reference counter.
 
virtual ~Standard_Transient ()
 Destructor must be virtual.
 
virtual const opencascade::handle< Standard_Type > & DynamicType () const
 Returns a type descriptor about this object.
 
Standard_Boolean IsInstance (const opencascade::handle< Standard_Type > &theType) const
 Returns a true value if this is an instance of Type.
 
Standard_Boolean IsInstance (const Standard_CString theTypeName) const
 Returns a true value if this is an instance of TypeName.
 
Standard_Boolean IsKind (const opencascade::handle< Standard_Type > &theType) const
 Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
 
Standard_Boolean IsKind (const Standard_CString theTypeName) const
 Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
 
Standard_TransientThis () const
 Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero.
 
Standard_Integer GetRefCount () const noexcept
 Get the reference counter of this object.
 
void IncrementRefCounter () noexcept
 Increments the reference counter of this object.
 
Standard_Integer DecrementRefCounter () noexcept
 Decrements the reference counter of this object; returns the decremented value.
 
virtual void Delete () const
 Memory deallocator for transient classes.
 

Data Fields

list of overridden properties
bool myIsHidden
 
bool myHasOwnMaterial
 
bool myHasOwnColor
 
bool myHasOwnTransp
 
bool myHasOwnWidth
 

Additional Inherited Members

- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object.
 
- Static Public Member Functions inherited from Standard_Transient
static constexpr const charget_type_name ()
 Returns a type descriptor about this object.
 
static const opencascade::handle< Standard_Type > & get_type_descriptor ()
 Returns type descriptor of Standard_Transient class.
 
- Protected Attributes inherited from Prs3d_Drawer
Handle< Prs3d_DrawermyLink
 the most edge continuity class (GeomAbs_Shape) to be included to face boundaries presentation, or -1 if undefined
 
Standard_Integer myNbPoints
 the most edge continuity class (GeomAbs_Shape) to be included to face boundaries presentation, or -1 if undefined
 
Standard_Real myMaximalParameterValue
 the most edge continuity class (GeomAbs_Shape) to be included to face boundaries presentation, or -1 if undefined
 
Standard_Real myChordialDeviation
 the most edge continuity class (GeomAbs_Shape) to be included to face boundaries presentation, or -1 if undefined
 
Aspect_TypeOfDeflection myTypeOfDeflection
 the most edge continuity class (GeomAbs_Shape) to be included to face boundaries presentation, or -1 if undefined
 
Standard_Boolean myHasOwnTypeOfDeflection
 the most edge continuity class (GeomAbs_Shape) to be included to face boundaries presentation, or -1 if undefined
 
Prs3d_TypeOfHLR myTypeOfHLR
 the most edge continuity class (GeomAbs_Shape) to be included to face boundaries presentation, or -1 if undefined
 
Standard_Real myDeviationCoefficient
 the most edge continuity class (GeomAbs_Shape) to be included to face boundaries presentation, or -1 if undefined
 
Standard_Real myPreviousDeviationCoefficient
 the most edge continuity class (GeomAbs_Shape) to be included to face boundaries presentation, or -1 if undefined
 
Standard_Real myDeviationAngle
 the most edge continuity class (GeomAbs_Shape) to be included to face boundaries presentation, or -1 if undefined
 
Standard_Real myPreviousDeviationAngle
 the most edge continuity class (GeomAbs_Shape) to be included to face boundaries presentation, or -1 if undefined
 
Standard_Boolean myIsoOnPlane
 the most edge continuity class (GeomAbs_Shape) to be included to face boundaries presentation, or -1 if undefined
 
Standard_Boolean myHasOwnIsoOnPlane
 the most edge continuity class (GeomAbs_Shape) to be included to face boundaries presentation, or -1 if undefined
 
Standard_Boolean myIsoOnTriangulation
 the most edge continuity class (GeomAbs_Shape) to be included to face boundaries presentation, or -1 if undefined
 
Standard_Boolean myHasOwnIsoOnTriangulation
 the most edge continuity class (GeomAbs_Shape) to be included to face boundaries presentation, or -1 if undefined
 
Standard_Boolean myIsAutoTriangulated
 the most edge continuity class (GeomAbs_Shape) to be included to face boundaries presentation, or -1 if undefined
 
Standard_Boolean myHasOwnIsAutoTriangulated
 the most edge continuity class (GeomAbs_Shape) to be included to face boundaries presentation, or -1 if undefined
 
Handle< Prs3d_IsoAspectmyUIsoAspect
 the most edge continuity class (GeomAbs_Shape) to be included to face boundaries presentation, or -1 if undefined
 
Handle< Prs3d_IsoAspectmyVIsoAspect
 the most edge continuity class (GeomAbs_Shape) to be included to face boundaries presentation, or -1 if undefined
 
Handle< Prs3d_LineAspectmyWireAspect
 the most edge continuity class (GeomAbs_Shape) to be included to face boundaries presentation, or -1 if undefined
 
Standard_Boolean myWireDraw
 the most edge continuity class (GeomAbs_Shape) to be included to face boundaries presentation, or -1 if undefined
 
Standard_Boolean myHasOwnWireDraw
 the most edge continuity class (GeomAbs_Shape) to be included to face boundaries presentation, or -1 if undefined
 
Handle< Prs3d_PointAspectmyPointAspect
 the most edge continuity class (GeomAbs_Shape) to be included to face boundaries presentation, or -1 if undefined
 
Handle< Prs3d_LineAspectmyLineAspect
 the most edge continuity class (GeomAbs_Shape) to be included to face boundaries presentation, or -1 if undefined
 
Handle< Prs3d_TextAspectmyTextAspect
 the most edge continuity class (GeomAbs_Shape) to be included to face boundaries presentation, or -1 if undefined
 
Handle< Prs3d_ShadingAspectmyShadingAspect
 the most edge continuity class (GeomAbs_Shape) to be included to face boundaries presentation, or -1 if undefined
 
Handle< Prs3d_PlaneAspectmyPlaneAspect
 the most edge continuity class (GeomAbs_Shape) to be included to face boundaries presentation, or -1 if undefined
 
Handle< Prs3d_LineAspectmySeenLineAspect
 the most edge continuity class (GeomAbs_Shape) to be included to face boundaries presentation, or -1 if undefined
 
Handle< Prs3d_ArrowAspectmyArrowAspect
 the most edge continuity class (GeomAbs_Shape) to be included to face boundaries presentation, or -1 if undefined
 
Standard_Boolean myLineArrowDraw
 the most edge continuity class (GeomAbs_Shape) to be included to face boundaries presentation, or -1 if undefined
 
Standard_Boolean myHasOwnLineArrowDraw
 the most edge continuity class (GeomAbs_Shape) to be included to face boundaries presentation, or -1 if undefined
 
Handle< Prs3d_LineAspectmyHiddenLineAspect
 the most edge continuity class (GeomAbs_Shape) to be included to face boundaries presentation, or -1 if undefined
 
Standard_Boolean myDrawHiddenLine
 the most edge continuity class (GeomAbs_Shape) to be included to face boundaries presentation, or -1 if undefined
 
Standard_Boolean myHasOwnDrawHiddenLine
 the most edge continuity class (GeomAbs_Shape) to be included to face boundaries presentation, or -1 if undefined
 
Handle< Prs3d_LineAspectmyVectorAspect
 the most edge continuity class (GeomAbs_Shape) to be included to face boundaries presentation, or -1 if undefined
 
Prs3d_VertexDrawMode myVertexDrawMode
 the most edge continuity class (GeomAbs_Shape) to be included to face boundaries presentation, or -1 if undefined
 
Handle< Prs3d_DatumAspectmyDatumAspect
 the most edge continuity class (GeomAbs_Shape) to be included to face boundaries presentation, or -1 if undefined
 
Handle< Prs3d_LineAspectmySectionAspect
 the most edge continuity class (GeomAbs_Shape) to be included to face boundaries presentation, or -1 if undefined
 
Handle< Prs3d_LineAspectmyFreeBoundaryAspect
 the most edge continuity class (GeomAbs_Shape) to be included to face boundaries presentation, or -1 if undefined
 
Standard_Boolean myFreeBoundaryDraw
 the most edge continuity class (GeomAbs_Shape) to be included to face boundaries presentation, or -1 if undefined
 
Standard_Boolean myHasOwnFreeBoundaryDraw
 the most edge continuity class (GeomAbs_Shape) to be included to face boundaries presentation, or -1 if undefined
 
Handle< Prs3d_LineAspectmyUnFreeBoundaryAspect
 the most edge continuity class (GeomAbs_Shape) to be included to face boundaries presentation, or -1 if undefined
 
Standard_Boolean myUnFreeBoundaryDraw
 the most edge continuity class (GeomAbs_Shape) to be included to face boundaries presentation, or -1 if undefined
 
Standard_Boolean myHasOwnUnFreeBoundaryDraw
 the most edge continuity class (GeomAbs_Shape) to be included to face boundaries presentation, or -1 if undefined
 
Handle< Prs3d_LineAspectmyFaceBoundaryAspect
 the most edge continuity class (GeomAbs_Shape) to be included to face boundaries presentation, or -1 if undefined
 
Standard_Integer myFaceBoundaryUpperContinuity
 the most edge continuity class (GeomAbs_Shape) to be included to face boundaries presentation, or -1 if undefined
 
Standard_Boolean myFaceBoundaryDraw
 the most edge continuity class (GeomAbs_Shape) to be included to face boundaries presentation, or -1 if undefined
 
Standard_Boolean myHasOwnFaceBoundaryDraw
 the most edge continuity class (GeomAbs_Shape) to be included to face boundaries presentation, or -1 if undefined
 
Handle< Prs3d_DimensionAspectmyDimensionAspect
 the most edge continuity class (GeomAbs_Shape) to be included to face boundaries presentation, or -1 if undefined
 
Prs3d_DimensionUnits myDimensionModelUnits
 the most edge continuity class (GeomAbs_Shape) to be included to face boundaries presentation, or -1 if undefined
 
Standard_Boolean myHasOwnDimLengthModelUnits
 the most edge continuity class (GeomAbs_Shape) to be included to face boundaries presentation, or -1 if undefined
 
Standard_Boolean myHasOwnDimAngleModelUnits
 the most edge continuity class (GeomAbs_Shape) to be included to face boundaries presentation, or -1 if undefined
 
Prs3d_DimensionUnits myDimensionDisplayUnits
 the most edge continuity class (GeomAbs_Shape) to be included to face boundaries presentation, or -1 if undefined
 
Standard_Boolean myHasOwnDimLengthDisplayUnits
 the most edge continuity class (GeomAbs_Shape) to be included to face boundaries presentation, or -1 if undefined
 
Standard_Boolean myHasOwnDimAngleDisplayUnits
 the most edge continuity class (GeomAbs_Shape) to be included to face boundaries presentation, or -1 if undefined
 
- Protected Attributes inherited from Graphic3d_PresentationAttributes
Handle< Graphic3d_AspectFillArea3dmyBasicFillAreaAspect
 presentation fill area aspect
 
Quantity_ColorRGBA myBasicColor
 presentation color
 
Aspect_TypeOfHighlightMethod myHiMethod
 box or color highlighting
 
Graphic3d_ZLayerId myZLayer
 Z-layer.
 
Standard_Integer myDispMode
 display mode
 

Detailed Description

Customizable properties.

Constructor & Destructor Documentation

◆ AIS_ColoredDrawer()

AIS_ColoredDrawer::AIS_ColoredDrawer ( const Handle< Prs3d_Drawer > &  theLink)
inline

Default constructor.

Member Function Documentation

◆ HasOwnColor()

bool AIS_ColoredDrawer::HasOwnColor ( ) const
inline

◆ HasOwnMaterial()

bool AIS_ColoredDrawer::HasOwnMaterial ( ) const
inline

◆ HasOwnTransparency()

bool AIS_ColoredDrawer::HasOwnTransparency ( ) const
inline

◆ HasOwnWidth()

bool AIS_ColoredDrawer::HasOwnWidth ( ) const
inline

◆ IsHidden()

bool AIS_ColoredDrawer::IsHidden ( ) const
inline

◆ SetHidden()

void AIS_ColoredDrawer::SetHidden ( const bool  theToHide)
inline

◆ SetOwnColor()

void AIS_ColoredDrawer::SetOwnColor ( const Quantity_Color )
inline

◆ SetOwnMaterial()

void AIS_ColoredDrawer::SetOwnMaterial ( )
inline

◆ SetOwnTransparency()

void AIS_ColoredDrawer::SetOwnTransparency ( Standard_Real  )
inline

◆ SetOwnWidth()

void AIS_ColoredDrawer::SetOwnWidth ( const Standard_Real  )
inline

◆ UnsetOwnColor()

void AIS_ColoredDrawer::UnsetOwnColor ( )
inline

◆ UnsetOwnMaterial()

void AIS_ColoredDrawer::UnsetOwnMaterial ( )
inline

◆ UnsetOwnTransparency()

void AIS_ColoredDrawer::UnsetOwnTransparency ( )
inline

◆ UnsetOwnWidth()

void AIS_ColoredDrawer::UnsetOwnWidth ( )
inline

Field Documentation

◆ myHasOwnColor

bool AIS_ColoredDrawer::myHasOwnColor

◆ myHasOwnMaterial

bool AIS_ColoredDrawer::myHasOwnMaterial

◆ myHasOwnTransp

bool AIS_ColoredDrawer::myHasOwnTransp

◆ myHasOwnWidth

bool AIS_ColoredDrawer::myHasOwnWidth

◆ myIsHidden

bool AIS_ColoredDrawer::myIsHidden

The documentation for this class was generated from the following file: