This class allows the definition of a group of attributes for the primitive MARKER. the attributes are: More...
#include <Aspect_AspectMarker.hxx>
Inheritance diagram for Aspect_AspectMarker:
Public Member Functions | |
| void | SetColor (const Quantity_Color &AColor) |
| Modifies the colour of <me>. More... | |
| void | SetScale (const Standard_Real AScale) |
| Modifies the scale factor of <me>. Marker type Aspect_TOM_POINT is not affected by the marker size scale factor. It is always the smallest displayable dot. Warning: Raises AspectMarkerDefinitionError if the scale is a negative value. More... | |
| void | SetType (const Aspect_TypeOfMarker AType) |
| Modifies the type of marker <me>. More... | |
| void | Values (Quantity_Color &AColor, Aspect_TypeOfMarker &AType, Standard_Real &AScale) const |
| Returns the current values of the group <me>. More... | |
 Public Member Functions inherited from MMgt_TShared | |
| virtual void | Delete () const override |
| Memory deallocator for transient classes. More... | |
| Public Member Functions inherited from Standard_Transient | |
| Standard_Transient () | |
| Empty constructor. More... | |
| Standard_Transient (const Standard_Transient &) | |
| Copy constructor – does nothing. More... | |
| Standard_Transient & | operator= (const Standard_Transient &) |
| Assignment operator, needed to avoid copying reference counter. More... | |
| virtual | ~Standard_Transient () |
| Destructor must be virtual. More... | |
| virtual const opencascade::handle< Standard_Type > & | DynamicType () const |
| Returns a type descriptor about this object. More... | |
| Standard_Boolean | IsInstance (const opencascade::handle< Standard_Type > &theType) const |
| Returns a true value if this is an instance of Type. More... | |
| Standard_Boolean | IsInstance (const Standard_CString theTypeName) const |
| Returns a true value if this is an instance of TypeName. More... | |
| 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. More... | |
| 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. More... | |
| Standard_Transient * | This () 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. More... | |
| Standard_Integer | GetRefCount () const |
| Get the reference counter of this object. More... | |
| void | IncrementRefCounter () const |
| Increments the reference counter of this object. More... | |
| Standard_Integer | DecrementRefCounter () const |
| Decrements the reference counter of this object; returns the decremented value. More... | |
Protected Member Functions | |
| Aspect_AspectMarker () | |
| Initialise the constructor for Graphic3d_AspectMarker3d. More... | |
| Aspect_AspectMarker (const Quantity_Color &AColor, const Aspect_TypeOfMarker AType, const Standard_Real AScale) | |
| Initialise the values for the constructor of Graphic3d_AspectMarker3d. Warning: Raises AspectMarkerDefinitionError if the scale is a negative value. More... | |
Additional Inherited Members | |
| Public Types inherited from Standard_Transient | |
| typedef void | base_type |
| Returns a type descriptor about this object. More... | |
| Static Public Member Functions inherited from Standard_Transient | |
| static const char * | get_type_name () |
| Returns a type descriptor about this object. More... | |
| static const opencascade::handle< Standard_Type > & | get_type_descriptor () |
| Returns type descriptor of Standard_Transient class. More... | |
Detailed Description
This class allows the definition of a group of attributes for the primitive MARKER. the attributes are:
- Colour
- Type
- Scale factor When any value of the group is modified all graphic objects using the group are modified
Constructor & Destructor Documentation
|
protected |
Initialise the constructor for Graphic3d_AspectMarker3d.
defaults values :
Color = Quantity_NOC_YELLOW; Type = Aspect_TOM_X; Scale = 1.0;
|
protected |
Initialise the values for the constructor of Graphic3d_AspectMarker3d. Warning: Raises AspectMarkerDefinitionError if the scale is a negative value.
Member Function Documentation
| void Aspect_AspectMarker::SetColor | ( | const Quantity_Color & | AColor | ) |
Modifies the colour of <me>.
| void Aspect_AspectMarker::SetScale | ( | const Standard_Real | AScale | ) |
Modifies the scale factor of <me>. Marker type Aspect_TOM_POINT is not affected by the marker size scale factor. It is always the smallest displayable dot. Warning: Raises AspectMarkerDefinitionError if the scale is a negative value.
| void Aspect_AspectMarker::SetType | ( | const Aspect_TypeOfMarker | AType | ) |
Modifies the type of marker <me>.
| void Aspect_AspectMarker::Values | ( | Quantity_Color & | AColor, |
| Aspect_TypeOfMarker & | AType, | ||
| Standard_Real & | AScale | ||
| ) | const |
Returns the current values of the group <me>.
The documentation for this class was generated from the following file:
