#include <DbMLeader.h>
Additional Inherited Members | |
 Static Public Member Functions inherited from OdRxObject | |
| static OdRxObjectPtr | cast (const OdRxObject *pointer) |
| static OdRxClass * | desc () |
| Protected Attributes inherited from OdDbObject | |
| OdDbObjectImpl * | m_pImpl |
Detailed Description
This class is the main class used for the multiple leader (MLeader) objects.
- See also
- TD_Db
<group OdDb_Classes>
Definition at line 48 of file DbMLeader.h.
Member Enumeration Documentation
◆ gsMarkType
Enumeration for MLeader GS mark type.
Definition at line 74 of file DbMLeader.h.
◆ LeaderLineOverrideType
Enumeration of the individual leader line properties which can be overridden.
| Enumerator | |
|---|---|
| kOverrideLeaderType | Leader line type (OdDbMLeaderStyle::LeaderType). |
| kOverrideLineColor | Leader line color. |
| kOverrideLineTypeId | Leader line linetype ID. |
| kOverrideLineWeight | Leader line weight. |
| kOverrideArrowSize | Leader line arrow size. |
| kOverrideArrowSymbolId | Leader line arrow symbol. |
Definition at line 1393 of file DbMLeader.h.
◆ MoveType
Enumeration for MLeader move type.
Definition at line 54 of file DbMLeader.h.
◆ PropertyOverrideType
Enumeration for MLeader properties which can be overridden.
Definition at line 124 of file DbMLeader.h.
Constructor & Destructor Documentation
◆ OdDbMLeader()
| OdDbMLeader::OdDbMLeader | ( | ) |
Member Function Documentation
◆ addFirstVertex()
| OdResult OdDbMLeader::addFirstVertex | ( | int | leaderLineIndex, |
| const OdGePoint3d & | point | ||
| ) |
Inserts a new first vertex into the specified leader line.
- Parameters
-
leaderLineIndex [in] Index of the leader line to which the vertex will be added. point [in] The position of the vertex.
◆ addLastVertex()
| OdResult OdDbMLeader::addLastVertex | ( | int | leaderLineIndex, |
| const OdGePoint3d & | point | ||
| ) |
Appends a new last vertex onto the specified leader line.
- Parameters
-
leaderLineIndex [in] Leader line index. point [in] The new vertex position.
- Returns
- Returns eOk if successful.
◆ addLeader()
| void OdDbMLeader::addLeader | ( | int & | leaderIndex | ) |
Causes a new cluster to be added to this MLeader object, and returns the index of the new cluster.
- Parameters
-
leaderIndex [out] Index of newly added cluster.
- Remarks
- A leader cluster consists of a dog-leg and leader lines.
◆ addLeaderLine() [1/2]
| OdResult OdDbMLeader::addLeaderLine | ( | const OdGePoint3d & | point, |
| int & | leaderLineIndex | ||
| ) |
Adds a new leader line to this MLeader. The first point of the new leader line is passed in.
- Parameters
-
point [in] Specifies the first point of the new leader line. leaderLineIndex [out] Receives the index of the newly added leader line.
- Returns
- Returns eOk if successful.
◆ addLeaderLine() [2/2]
| OdResult OdDbMLeader::addLeaderLine | ( | int | leaderIndex, |
| int & | leaderLineIndex | ||
| ) |
Adds a leader line to the leader cluster specified by the supplied index.
- Parameters
-
leaderIndex [in] Leader cluster index. leaderLineIndex [out] Receives the index of the newly added leader line.
◆ arrowSize() [1/2]
| double OdDbMLeader::arrowSize | ( | ) | const |
Returns the arrow size for this MLeader object.
◆ arrowSize() [2/2]
| double OdDbMLeader::arrowSize | ( | int | leaderLineIndex | ) | const |
Returns the arrow size for a specified leader line.
- Parameters
-
leaderLineIndex [in] Leader line index.
◆ arrowSymbolId() [1/2]
| OdDbObjectId OdDbMLeader::arrowSymbolId | ( | ) | const |
Returns the arrow symbol for this MLeader (by ObjectId).
◆ arrowSymbolId() [2/2]
| OdDbObjectId OdDbMLeader::arrowSymbolId | ( | int | leaderLineIndex | ) | const |
Returns the arrow head symbol for a specified leader line, by ObjectId.
- Parameters
-
leaderLineIndex [in] Leader line index.
◆ blockColor()
| OdCmColor OdDbMLeader::blockColor | ( | ) | const |
Returns the color used for block content.
◆ blockConnectionType()
| OdDbMLeaderStyle::BlockConnectionType OdDbMLeader::blockConnectionType | ( | ) | const |
Returns the block connection type for this MLeader, which specifies how the referenced block is connected to the leader lines.
◆ blockContentId()
| OdDbObjectId OdDbMLeader::blockContentId | ( | ) | const |
Returns the referenced block for this MLeader, by block ObjectId.
◆ blockRotation()
| double OdDbMLeader::blockRotation | ( | ) | const |
Returns the rotation used by the referenced block.
◆ blockScale()
| OdGeScale3d OdDbMLeader::blockScale | ( | ) | const |
Returns the scale used by the referenced block.
◆ connectionPoint() [1/2]
| OdResult OdDbMLeader::connectionPoint | ( | const OdGeVector3d & | vect, |
| OdGePoint3d & | point | ||
| ) | const |
Returns the connection point of this MLeader, for the speciefied direction.
- Parameters
-
vect [in] The specified direction. point [out] Receives the connection point.
◆ connectionPoint() [2/2]
| OdResult OdDbMLeader::connectionPoint | ( | const OdGeVector3d & | vect, |
| OdGePoint3d & | point, | ||
| OdDbMLeaderStyle::TextAttachmentDirection | direction | ||
| ) | const |
Returns the connection point of this MLeader, for the speciefied direction.
- Parameters
-
vect [in] The specified direction. point [out] Receives the connection point. direction The text attachment direction of MText. (Horizontally by default).
◆ contentType()
| OdDbMLeaderStyle::ContentType OdDbMLeader::contentType | ( | ) | const |
Returns the content type for this MLeader object.
◆ copyFrom()
|
virtual |
Copies the contents of the specified object into this object when possible.
- Parameters
-
pSource [in] Pointer to the source object.
- Remarks
- The source object and this object need not be of the same type.
This function is meaningful only when implemented by custom classes.
Throws:
Cause eNullObjectPointer pSource->isNull()
Reimplemented from OdDbEntity.
◆ doglegLength() [1/2]
| double OdDbMLeader::doglegLength | ( | ) | const |
◆ doglegLength() [2/2]
| double OdDbMLeader::doglegLength | ( | int | leaderIndex | ) |
Returns the length for the dog-leg of the specified leader cluster.
- Parameters
-
leaderIndex [in] Leader index.
◆ dwgInFields()
|
virtual |
Reads the .dwg file data of this object.
- Parameters
-
pFiler [in] Filer object from which data are read.
- Returns
- Returns the filer status.
This function is called by dwgIn() to allow the object to read its data.
When overriding this function:
1) Call assertWriteEnabled(). 2) Call the parent class's dwgInFields(pFiler). 3) If it returns eOK, continue; otherwise return whatever the parent's dwgInFields(pFiler) returned. 4) Call the OdDbDwgFiler(pFiler) methods to read each of the object's data items in the order they were written. 5) Return pFiler->filerStatus().
Reimplemented from OdDbEntity.
◆ dwgOutFields()
|
virtual |
Writes the .dwg file data of this object.
- Parameters
-
pFiler [in] Pointer to the filer to which data are written.
- Remarks
This function is called by dwgIn() to allow the object to write its data.
When overriding this function:
1) Call assertReadEnabled(). 2) Call the parent class's dwgOutFields(pFiler). 3) Call the OdDbDwgFiler(pFiler) methods to write each of the object's data items in the order they were written.
Reimplemented from OdDbEntity.
◆ dxfInFields()
|
virtual |
Reads the DXF data of this object.
- Parameters
-
pFiler [in] Pointer to the filer from which data are read.
- Returns
- Returns the filer status.
This function is called by dxfIn() to allow the object to read its data.
When overriding this function:
1) Call assertWriteEnabled(). 2) Call the parent class's dwgInFields(pFiler). 3) If it returns eOK, continue; otherwise return whatever the parent's dxfInFields(pFiler) returned. 4) Call the OdDbDxfFiler(pFiler) methods to read each of the object's data items in the order they were written. 5) Return pFiler->filerStatus().
Reimplemented from OdDbEntity.
◆ dxfOutFields()
|
virtual |
Writes the DXF data of this object.
- Parameters
-
pFiler [in] Pointer to the filer to which data are to be written.
- Remarks
This function is called by dxfOut() to allow the object to write its data.
When overriding this function:
1) Call assertReadEnabled(). 2) Call the parent class's dxfOutFields(pFiler). 4) Use pFiler to call the OdDbDxfFiler methods to write each of the object's data items in the order they were written.
Reimplemented from OdDbEntity.
◆ enableAnnotationScale()
| bool OdDbMLeader::enableAnnotationScale | ( | ) | const |
Returns the annotation scale enabled status for this MLeader.
◆ enableDogleg()
| bool OdDbMLeader::enableDogleg | ( | ) | const |
Returns the enabled/disabled status for dog-leg leader line.
◆ enableFrameText()
| bool OdDbMLeader::enableFrameText | ( | ) | const |
Returns the text frame visibility for MText content.
◆ enableLanding()
| bool OdDbMLeader::enableLanding | ( | ) | const |
Returns the enabled/disabled status for leader landing line.
◆ extendLeaderToText()
| bool OdDbMLeader::extendLeaderToText | ( | ) | const |
Returns extend to text mode flag.
◆ getBlockAttributeValue()
| OdResult OdDbMLeader::getBlockAttributeValue | ( | OdDbObjectId | attdefId, |
| OdDbAttributePtr & | pAtt | ||
| ) | const |
Returns the specified attribute from the associated block content.
- Parameters
-
attdefId [in] ObjectID of an attribute definition. pAtt [out] Returned attribute object corresponding to attdefId.
- Remarks
- If successful, returns eOk.
◆ getBlockPosition()
| void OdDbMLeader::getBlockPosition | ( | OdGePoint3d & | position | ) |
Returns the position for the block referenced by this MLeader.
- Parameters
-
position [out] Receives the block position.
◆ getContentGeomExtents()
| OdResult OdDbMLeader::getContentGeomExtents | ( | OdGeExtents3d & | extents | ) | const |
Returns the the extents of the content for this MLeader.
- Parameters
-
extents [out] Receives the content extents.
- Returns
- Returns eOk if successful.
◆ getContextDataManager()
| void* OdDbMLeader::getContextDataManager | ( | ) | const |
Returns the context data manager for this MLeader object.
◆ getDoglegDirection()
| void OdDbMLeader::getDoglegDirection | ( | int | leaderIndex, |
| OdGeVector3d & | vector | ||
| ) |
Returns the dog-leg direction for the specified leader cluster.
- Remarks
- Parameters
-
leaderIndex [in] Leader index. vector [out] Receives the dog-leg direction.
◆ getFirstVertex()
| OdResult OdDbMLeader::getFirstVertex | ( | int | leaderLineIndex, |
| OdGePoint3d & | point | ||
| ) | const |
Returns the first vertex from the specified leader line.
- Parameters
-
leaderLineIndex [in] Leader line index. point [out] Receives the first vertex.
- Returns
- Returns eOk if successful.
◆ getLastVertex()
| OdResult OdDbMLeader::getLastVertex | ( | int | leaderLineIndex, |
| OdGePoint3d & | point | ||
| ) | const |
Returns the last vertex from the specified leader line.
- Parameters
-
leaderLineIndex [in] Leader line index. point [out] Receives the last vertex from the specified leader line.
- Returns
- Returns eOk if successful.
◆ getLeaderIndex()
| void OdDbMLeader::getLeaderIndex | ( | int | leaderLineIndex, |
| int & | leaderIndex | ||
| ) |
Returns the index of the leader cluster which contains the specified leader line.
- Parameters
-
leaderLineIndex [in] Leader line index. leaderIndex [out] Receives the index of the lead line owner.
◆ getLeaderIndexes()
| void OdDbMLeader::getLeaderIndexes | ( | OdIntArray & | leaderIndexes | ) |
- Parameters
-
leaderIndexes [out] Returned indexes.
◆ getLeaderLineIndexes() [1/2]
| void OdDbMLeader::getLeaderLineIndexes | ( | int | leaderIndex, |
| OdIntArray & | leaderLineIndexes | ||
| ) |
Returns the indexes of all leader lines for the specified leader.
- Parameters
-
leaderIndex [in] Leader index. leaderLineIndexes [out] Receives the indexes of the owned leader lines.
◆ getLeaderLineIndexes() [2/2]
| void OdDbMLeader::getLeaderLineIndexes | ( | OdIntArray & | leaderLineIndexes | ) |
Returns the indexes of all leader lines for this MLeader object.
- Parameters
-
leaderIndexes [out] Receives the indexes of leader lines for this MLeader.
◆ getOverridedMLeaderStyle()
| OdResult OdDbMLeader::getOverridedMLeaderStyle | ( | OdDbMLeaderStyle & | mleaderStyle | ) |
Returns the property set for the MLeader, including override values.
- Parameters
-
mleaderStyle [out] Receives the properties of this MLeader.
- Returns
- Returns eOk if successful.
◆ getPlane()
|
virtual |
Returns the plane that contains this entity.
- Parameters
-
plane [out] Receives the plane that contains this entity. planarity [out] Receives the planarity of this entity.
- Returns
- Returns eOk if successful, or an appropriate error code if not.
planarity and plane return values as follows::
Value Description plane kNonPlanar 0 Non-planar Not set kPlanar 1 Planar Entity plane kLinear 2 Linear Arrbitrary plane containing this entity
Reimplemented from OdDbEntity.
◆ getTextLocation()
| void OdDbMLeader::getTextLocation | ( | OdGePoint3d & | location | ) |
Returns the location for the MText content associated with this MLeader.
- Parameters
-
location [out] Receives the MText location.
◆ getToleranceLocation()
| OdResult OdDbMLeader::getToleranceLocation | ( | OdGePoint3d & | location | ) | const |
Returns the location for MLeader tolerance content.
- Parameters
-
location [out] Receives the MLeader tolerance content location.
Returns eOk if successful.
◆ getVertex()
| void OdDbMLeader::getVertex | ( | int | leaderLineIndex, |
| int | index, | ||
| OdGePoint3d & | point | ||
| ) |
Returns the position of a specified vertex in a specified leader line.
- Parameters
-
leaderLineIndex [in] Leader line index. index [in] The index of the vertex. point [out] Receives the position value for the specified vertex.
- Returns
- Returns eOk if successful.
◆ hasContent()
| bool OdDbMLeader::hasContent | ( | ) | const |
Returns true if this MLeader has content, false otherwise.
◆ isOverride() [1/2]
| bool OdDbMLeader::isOverride | ( | int | leaderLineIndex, |
| LeaderLineOverrideType | value | ||
| ) |
Returns the override status for the specified line property.
- Parameters
-
leaderLineIndex [in] Leader line index for which status is to be returned. value [in] property identifier
- Returns
- Returns true if an override has been set for the specified property, false otherwise. (Override is set in the set* functions listed below, which accept leader line index as a first argument)
◆ isOverride() [2/2]
| bool OdDbMLeader::isOverride | ( | PropertyOverrideType | propertyType | ) | const |
Returns the override status for the specified PropertyOverrideType.
- Parameters
-
propertyType [in] PropertyOverrideType for which status is to be returned.
- Returns
- Returns true if an override has been set for the specified propertyType, false otherwise.
◆ isPlanar()
|
virtual |
Returns true if and only if this entity is planar.
Reimplemented from OdDbEntity.
◆ landingGap()
| double OdDbMLeader::landingGap | ( | ) | const |
Returns the landing gap for this MLeader (gap between the leader tail and associated MText).
◆ leaderLineColor() [1/2]
| OdCmColor OdDbMLeader::leaderLineColor | ( | ) | const |
Returns the leader line color for this MLeader.
◆ leaderLineColor() [2/2]
| OdCmColor OdDbMLeader::leaderLineColor | ( | int | leaderLineIndex | ) | const |
Returns the leader line color for the specified leader line.
- Parameters
-
leaderLineIndex [in] Leader line index for which color is to be returned.
◆ leaderLineType() [1/2]
| OdDbMLeaderStyle::LeaderType OdDbMLeader::leaderLineType | ( | ) | const |
Returns the leader line type for this MLeader object.
◆ leaderLineType() [2/2]
| OdDbMLeaderStyle::LeaderType OdDbMLeader::leaderLineType | ( | int | leaderLineIndex | ) | const |
Returns the leader line type for the specified leader line.
- Parameters
-
leaderLineIndex [in] Leader line index for which type is to be returned.
◆ leaderLineTypeId() [1/2]
| OdDbObjectId OdDbMLeader::leaderLineTypeId | ( | ) | const |
Returns the leader line linetype for this MLeader by OdDbObjectId.
◆ leaderLineTypeId() [2/2]
| OdDbObjectId OdDbMLeader::leaderLineTypeId | ( | int | leaderLineIndex | ) | const |
Returns the leader line linetype for the specified leader line.
- Parameters
-
leaderLineIndex [in] Leader line index.
◆ leaderLineWeight() [1/2]
| OdDb::LineWeight OdDbMLeader::leaderLineWeight | ( | ) | const |
Returns the leader line weight for this MLeader.
◆ leaderLineWeight() [2/2]
| OdDb::LineWeight OdDbMLeader::leaderLineWeight | ( | int | leaderLineIndex | ) | const |
Returns the leader line weight for the specified leader line.
- Parameters
-
leaderLineIndex [in] Leader line index.
◆ MLeaderStyle()
| OdDbObjectId OdDbMLeader::MLeaderStyle | ( | ) |
Returns the MLeaderStyle used for this MLeader, by ObjectId.
◆ modified()
|
protectedvirtual |
Notification function called whenever an object is opened OdDb::kForWrite, a function has been called that could modify the contents of this object, and this object is now being closed.
- Parameters
-
pObject [in] Pointer to the object that is being closed after being modified.
- Remarks
- The default implementation of this function does nothing. This function can be overridden in custom classes.
Reimplemented from OdDbObject.
◆ moveMLeader()
| OdResult OdDbMLeader::moveMLeader | ( | const OdGeVector3d & | vector, |
| MoveType | moveType, | ||
| bool | bAutoSwitchDogleg = true |
||
| ) |
Moves this MLeader object as specified by an input vector.
- Parameters
-
vector [in] Vector which specifies the direction and distance of the move. moveType [in] Indicates how to move the MLeader. bAutoSwitchDogleg [in] If true, automatically switch leader lines after movoing the MLeader.
- Returns
- Returns eOk if successful.
◆ mtext()
| OdDbMTextPtr OdDbMLeader::mtext | ( | ) | const |
Returns the MText content associated with this MLeader.
◆ normal()
| OdGeVector3d OdDbMLeader::normal | ( | ) | const |
◆ numVertices()
| OdResult OdDbMLeader::numVertices | ( | int | leaderLineIndex, |
| int & | num | ||
| ) | const |
Returns the number of vertices in the specified leader line.
- Parameters
-
leaderLineIndex [in] Leader line index. num [out] Receives the number of vertices in the specified leader line.
- Returns
- Returns eOk if successful.
◆ ODDB_DECLARE_MEMBERS()
| OdDbMLeader::ODDB_DECLARE_MEMBERS | ( | OdDbMLeader | ) |
◆ plane()
| OdGePlane OdDbMLeader::plane | ( | ) | const |
Returns the WCS plane containing this MLeader object.
◆ postMLeaderToDb()
| OdResult OdDbMLeader::postMLeaderToDb | ( | OdDbDatabase * | pDb | ) |
Adds this MLeader object to the Model Space block of the specified database.
- Parameters
-
pDb [in] Database to which this MLeader object should be added.
- Returns
- Returns eOk if successful.
◆ recomputeBreakPoints()
| OdResult OdDbMLeader::recomputeBreakPoints | ( | ) |
Recomputes the dimension break points.
- Returns
- Returns eOk if successful.
◆ removeFirstVertex()
| OdResult OdDbMLeader::removeFirstVertex | ( | int | leaderLineIndex | ) |
Removes the first vertex from the specified leader line.
- Parameters
-
leaderLineIndex [in] Index of the leader line from which the first vertex will be removed.
- Returns
- Returns eOk if successful.
◆ removeLastVertex()
| OdResult OdDbMLeader::removeLastVertex | ( | int | leaderLineIndex | ) |
Removes the last vertex from the specified leader line.
- Parameters
-
leaderLineIndex [in] Leader line index.
- Returns
- Returns eOk if successful.
◆ removeLeader()
| void OdDbMLeader::removeLeader | ( | int | leaderIndex | ) |
Removes the leader cluster specified by the passed-in index.
- Parameters
-
leaderIndex [in] Index of the cluster to be removed.
- Remarks
- A leader cluster consists of a dog-leg and leader lines.
◆ removeLeaderLine()
| void OdDbMLeader::removeLeaderLine | ( | int | leaderLineIndex | ) |
Removes the leader line specified by the passed-in index.
- Parameters
-
leaderLineIndex [in] Index of the leader line to remove.
- Remarks
- Note that removal of all leader lines will cause the leader cluster to be removed as well.
◆ removeLeaderLineRefAssoc()
| OdResult OdDbMLeader::removeLeaderLineRefAssoc | ( | int | leaderLineIndex | ) | const |
Removes the specified leader line's geometry association.
- Parameters
-
leaderLineIndex [in] Leader line index.
- Returns
- Returns eOk if successful.
◆ scale()
| double OdDbMLeader::scale | ( | ) | const |
Returns the MLeader scale, which affects arrowhead size and content scale.
◆ setArrowSize() [1/2]
| void OdDbMLeader::setArrowSize | ( | double | arrowSize | ) |
Sets the arrow size for this MLeader object.
- Parameters
-
arrowSize [in] Arrow size.
- Remarks
- The kArrowSize PropertyOverrideType override will be set as a result of calling this function.
◆ setArrowSize() [2/2]
| void OdDbMLeader::setArrowSize | ( | int | leaderLineIndex, |
| double | arrowSize | ||
| ) |
Sets the arrow size for the specified leader line.
- Parameters
-
leaderLineIndex [in] Leader line index. arrowSize [in] Arrow size.
- Remarks
- The kArrowSize PropertyOverrideType override will be set as a result of calling this function.
◆ setArrowSymbolId() [1/2]
| void OdDbMLeader::setArrowSymbolId | ( | int | leaderLineIndex, |
| OdDbObjectId | arrowSymbolId | ||
| ) |
Sets the arrow head symbol for a specified leader line, by ObjectId.
- Parameters
-
leaderLineIndex [in] Leader line index. arrowSymbolId [in] Arrow symbol ObjectId.
- Returns
- Returns eOk if successful.
◆ setArrowSymbolId() [2/2]
| void OdDbMLeader::setArrowSymbolId | ( | OdDbObjectId | arrowSymbolId | ) |
Sets the arrow symbol for this MLeader (by ObjectId).
- Parameters
-
arrowSymbolId [in] Arrow symbol ObjectId.
- Remarks
- The kDoglegLength PropertyOverrideType override will be set as a result of calling this function. If this value is not set, the default arrow symbol will be used.
◆ setBlockAttributeValue()
| OdResult OdDbMLeader::setBlockAttributeValue | ( | OdDbObjectId | attdefId, |
| const OdDbAttribute * | pAtt | ||
| ) |
Sets the specified attribute within associated block content.
- Parameters
-
attdefId [in] ObjectID of attribute definition. pAtt [in] Attribute object pointer.
- Returns
- Returns eOk if successful.
◆ setBlockColor()
Sets the color used for block content.
- Parameters
-
blockColor [in] Block color.
- Remarks
- The kBlockColor PropertyOverrideType override will be set as a result of calling this function.
◆ setBlockConnectionType()
| void OdDbMLeader::setBlockConnectionType | ( | OdDbMLeaderStyle::BlockConnectionType | blockConnectionType | ) |
Sets the block connection type for this MLeader, which specifies how the referenced block is connected to the leader lines.
- Parameters
-
blockConnectionType [in] Block connection type.
- Remarks
- The kBlockConnectionType PropertyOverrideType override will be set as a result of calling this function.
◆ setBlockContentId()
| void OdDbMLeader::setBlockContentId | ( | OdDbObjectId | blockId | ) |
Sets the referenced block for this MLeader, by block ObjectId.
- Parameters
-
blockId [in] Block table record ObjectId.
- Remarks
- The kBlockId PropertyOverrideType override will be set as a result of calling this function.
◆ setBlockPosition()
| void OdDbMLeader::setBlockPosition | ( | const OdGePoint3d & | position | ) |
Sets the position for the block referenced by this MLeader.
- Parameters
-
position [in] Block position.
◆ setBlockRotation()
| void OdDbMLeader::setBlockRotation | ( | double | rotation | ) |
Sets the rotation used by the referenced block.
- Parameters
-
rotation [in] Referenced block rotation.
- Remarks
- The kBlockRotation PropertyOverrideType override will be set as a result of calling this function.
◆ setBlockScale()
| void OdDbMLeader::setBlockScale | ( | const OdGeScale3d & | scale | ) |
Sets the scale used by the referenced block.
- Parameters
-
scale [in] Referenced block scale.
- Remarks
- The kBlockScale PropertyOverrideType override will be set as a result of calling this function.
◆ setContentType()
| void OdDbMLeader::setContentType | ( | OdDbMLeaderStyle::ContentType | contentType | ) |
Sets the content type for this MLeader object.
- Parameters
-
contentType [in] Content type.
- Remarks
- The kContentType PropertyOverrideType override will be set as a result of calling this function.
◆ setContextDataManager()
Sets the context data manager for this MLeader object.
- Parameters
-
pContextDataManager [in] Pointer to a context data manager.
- Returns
- Returns eOk if successful.
◆ setDoglegDirection()
| void OdDbMLeader::setDoglegDirection | ( | int | leaderIndex, |
| const OdGeVector3d & | vector | ||
| ) |
Sets the dog-leg direction for the specified leader cluster.
- Parameters
-
leaderIndex [in] Leader index. vector [in] The new dog-leg direction.
◆ setDoglegLength() [1/2]
| OdResult OdDbMLeader::setDoglegLength | ( | double | doglegLength | ) |
◆ setDoglegLength() [2/2]
| void OdDbMLeader::setDoglegLength | ( | int | leaderIndex, |
| double | dDoglegLength | ||
| ) |
Sets the length for the dog-leg of the specified leader cluster.
- Parameters
-
leaderIndex [in] Leader index. dDoglegLength [in] Dog-leg length.
- Remarks
- The kDoglegLength PropertyOverrideType override will be set as a result of calling this function.
◆ setEnableAnnotationScale()
| void OdDbMLeader::setEnableAnnotationScale | ( | bool | enableAnnotationScale | ) |
Sets the annotation scale enabled status for this MLeader.
- Parameters
-
enableAnnotationScale [in] true if annotation scale is to be enabled, false otherwise.
◆ setEnableDogleg()
| void OdDbMLeader::setEnableDogleg | ( | bool | enableDogleg | ) |
Sets the enabled/disabled status for dog-leg leader line.
- Parameters
-
enableDogleg [in] Leader dog-leg line enabled status.
- Remarks
- The kEnableDogleg PropertyOverrideType override will be set as a result of calling this function.
◆ setEnableFrameText()
| void OdDbMLeader::setEnableFrameText | ( | bool | enableFrameText | ) |
Sets the text frame visibility for MText content.
- Parameters
-
enableFrameText [in] True to enable the text frame, false otherwise.
- Remarks
- The kEnableFrameText PropertyOverrideType override will be set as a result of calling this function.
◆ setEnableLanding()
| void OdDbMLeader::setEnableLanding | ( | bool | enableLanding | ) |
Sets the enabled/disabled status for leader landing line.
- Parameters
-
enableLanding [in] Leader landing line enabled status.
- Remarks
- The kEnableLanding PropertyOverrideType override will be set as a result of calling this function.
◆ setExtendLeaderToText()
| void OdDbMLeader::setExtendLeaderToText | ( | bool | bSet | ) |
Set extend to text mode.
- Parameters
-
bSet [in] New value for extend to text mode flag.
◆ setFirstVertex()
| OdResult OdDbMLeader::setFirstVertex | ( | int | leaderLineIndex, |
| const OdGePoint3d & | point | ||
| ) |
Sets the first vertex of the specified leader line.
- Parameters
-
leaderLineIndex [in] Leader line index. point [in] New position for the first vertex.
- Remarks
- Note that this function only sets the values for an existing first vertex, but does not create any new vertices.
- Returns
- Returns eOk if successful.
◆ setLandingGap()
| void OdDbMLeader::setLandingGap | ( | double | landingGap | ) |
Sets the landing gap for this MLeader (gap between the leader tail and associated MText).
- Parameters
-
landingGap [in] Landing gap (gap between the leader tail and associated MText).
- Remarks
- The kLandingGap PropertyOverrideType override will be set as a result of calling this function.
◆ setLastVertex()
| OdResult OdDbMLeader::setLastVertex | ( | int | leaderLineIndex, |
| const OdGePoint3d & | point | ||
| ) |
Sets the last vertex of the specified leader line.
- Parameters
-
leaderLineIndex [in] Leader line index. point [in] New last vertex for specified leader line.
- Returns
- Returns eOk if successful.
◆ setLeaderLineColor() [1/2]
Sets the leader line color for this MLeader.
- Parameters
-
leaderLineColor [in] Leader line color.
- Remarks
- The kLeaderLineColor PropertyOverrideType override will be set as a result of calling this function.
◆ setLeaderLineColor() [2/2]
Sets the leader line color for the specified leader line.
- Parameters
-
leaderLineIndex [in] Leader line index. leaderLineColor [in] Leader line color.
- Remarks
- The kLeaderLineColor PropertyOverrideType override will be set as a result of calling this function.
◆ setLeaderLineType() [1/2]
| void OdDbMLeader::setLeaderLineType | ( | int | leaderLineIndex, |
| OdDbMLeaderStyle::LeaderType | leaderLineType | ||
| ) |
Sets the leader line type for the specified line.
- Parameters
-
leaderLineIndex [in] Leader line index. leaderLineType [in] Leader line type.
- Remarks
- The kLeaderLineType PropertyOverrideType override will be set as a result of calling this function.
◆ setLeaderLineType() [2/2]
| void OdDbMLeader::setLeaderLineType | ( | OdDbMLeaderStyle::LeaderType | leaderLineType | ) |
Sets the leader line type for this MLeader object.
- Parameters
-
leaderLineType [in] Leader line type.
- Remarks
- The kLeaderLineType PropertyOverrideType override will be set as a result of calling this function.
◆ setLeaderLineTypeId() [1/2]
| void OdDbMLeader::setLeaderLineTypeId | ( | int | leaderLineIndex, |
| OdDbObjectId | leaderLineTypeId | ||
| ) |
Sets the leader line linetype for the specified leader line.
- Parameters
-
leaderLineIndex [in] Leader line index. leaderLineTypeId [in] Leader line type ObjectId.
- Remarks
- The kLeaderLineTypeId PropertyOverrideType override will be set as a result of calling this function.
◆ setLeaderLineTypeId() [2/2]
| void OdDbMLeader::setLeaderLineTypeId | ( | OdDbObjectId | leaderLineTypeId | ) |
Sets the leader line linetype for this MLeader by OdDbObjectId.
- Parameters
-
leaderLineTypeId [in] Leader line type ObjectId.
- Remarks
- The kLeaderLineTypeId PropertyOverrideType override will be set as a result of calling this function.
◆ setLeaderLineWeight() [1/2]
| void OdDbMLeader::setLeaderLineWeight | ( | int | leaderLineIndex, |
| OdDb::LineWeight | leaderLineWeight | ||
| ) |
Sets the leader line weight for the specified leader line.
- Parameters
-
leaderLineIndex [in] Leader line index. leaderLineWeight [in] Leader line weight.
- Remarks
- The kLeaderLineWeight PropertyOverrideType override will be set as a result of calling this function.
◆ setLeaderLineWeight() [2/2]
| void OdDbMLeader::setLeaderLineWeight | ( | OdDb::LineWeight | leaderLineWeight | ) |
Sets the leader line weight for this MLeader.
- Parameters
-
leaderLineWeight [in] Leader line weight.
- Remarks
- The kLeaderLineWeight PropertyOverrideType override will be set as a result of calling this function.
◆ setMLeaderStyle()
| void OdDbMLeader::setMLeaderStyle | ( | OdDbObjectId | newStyleId | ) |
Sets the MLeaderStyle used for this MLeader, by ObjectId.
- Parameters
-
newStyleId [in] New MLeaderStyle.
◆ setMText()
Sets the MText object to be associated with this MLeader.
- Parameters
-
pMText [in] The MText object to associate with this MLeader (if NULL, the default MText defined in the associated MLeaderStyle is used).
- Remarks
- The kDefaultMText PropertyOverrideType override will be set as a result of calling this function. The supplied MText object can be DBR or non-DBR.
◆ setOverride()
| void OdDbMLeader::setOverride | ( | PropertyOverrideType | propertyType, |
| bool | isOverride = true |
||
| ) |
Sets the override status for the specified PropertyOverrideType.
- Parameters
-
propertyType [in] PropertyOverrideType which will be set. isOverride [in] true if an override for propertyType is to be set, false otherwise.
◆ setPlane()
Sets the WCS plane containing this MLeader object.
- Parameters
-
plane [in] Place which will contain the MLeader.
- Remarks
- Note that MLeader geometry will be updated appropriately to reflect the new location.
◆ setScale()
| OdResult OdDbMLeader::setScale | ( | double | scale | ) |
Sets the MLeader scale, which affects arrowhead size and content scale.
- Parameters
-
scale [in] The scale value.
- Returns
- Returns eOk if successful. Note that this function will set an override for kScale PropertyOverrideType.
◆ setTextAlignmentType()
| void OdDbMLeader::setTextAlignmentType | ( | OdDbMLeaderStyle::TextAlignmentType | textAlignmentType | ) |
Sets the text alignment type for MText content.
- Parameters
-
textAlignmentType [in] Text alignment type.
- Remarks
- The kTextAlignmentType PropertyOverrideType override will be set as a result of calling this function.
◆ setTextAngleType()
| void OdDbMLeader::setTextAngleType | ( | OdDbMLeaderStyle::TextAngleType | textAngleType | ) |
Sets the angle type for MText content, with respect to the last leader line segment.
- Parameters
-
textAngleType [in] Text text angle type.
- Remarks
- The kTextAngleType PropertyOverrideType override will be set as a result of calling this function.
◆ setTextAttachmentDirection()
| void OdDbMLeader::setTextAttachmentDirection | ( | OdDbMLeaderStyle::TextAttachmentDirection | direction | ) |
Sets the text attachment direction of MText.
- Parameters
-
direction [in] The text attachment direction of MText.
◆ setTextAttachmentType()
| void OdDbMLeader::setTextAttachmentType | ( | OdDbMLeaderStyle::TextAttachmentType | textAttachmentType, |
| OdDbMLeaderStyle::LeaderDirectionType | leaderDirection | ||
| ) |
Sets the text attachment type used by MText content.
- Parameters
-
textAttachmentType [in] Text attachment type. leaderDirection [in] Text leader direction type.
- Remarks
- The kTextLeftAttachmentType/kTextRightAttachmentType PropertyOverrideType override will be set as a result of calling this function.
◆ setTextColor()
Sets the text color for MText content.
- Parameters
-
textColor [in] Text color.
- Remarks
- The kTextColor PropertyOverrideType override will be set as a result of calling this function.
◆ setTextHeight()
| void OdDbMLeader::setTextHeight | ( | double | textHeight | ) |
Sets the text height for MText content.
- Parameters
-
textHeight [in] Text height.
- Remarks
- The kTextHeight PropertyOverrideType override will be set as a result of calling this function.
◆ setTextLocation()
| void OdDbMLeader::setTextLocation | ( | const OdGePoint3d & | location | ) |
Sets the location for the MText content associated with this MLeader.
- Parameters
-
location [in] MLeader mtext location.
◆ setTextStyleId()
| void OdDbMLeader::setTextStyleId | ( | OdDbObjectId | textStyleId | ) |
Sets the textstyle used by MText content (by ObjectId).
- Parameters
-
textStyleId [in] OdDbTextStyle ObjectId.
- Remarks
- The kTextStyleId PropertyOverrideType override will be set as a result of calling this function.
◆ setToleranceLocation()
| OdResult OdDbMLeader::setToleranceLocation | ( | const OdGePoint3d & | location | ) |
Sets the location for MLeader tolerance content.
- Parameters
-
location [in] MLeader tolerance content location
- Returns
- Returns eOk if successful.
◆ setVertex()
| OdResult OdDbMLeader::setVertex | ( | int | leaderLineIndex, |
| int | index, | ||
| const OdGePoint3d & | point | ||
| ) |
Sets the position for a specified vertex in a specified leader line.
- Parameters
-
leaderLineIndex [in] Leader line index. index [in] The index of the vertex to be set. point [in] New coordinate value for the specified vertex.
- Returns
- Returns eOk if successful.
◆ subClose()
|
protectedvirtual |
Called as the first operation as this object is being closed, for database -resident objects only.
- Remarks
- This function is notified just before the current open operation is to be closed, giving this function the ability to perform necessary operatons.
When overriding this function:
1) If the OdDbObject's state is incorrect, throw exception.
2) Call parent class's subClose().
3) If other actions are required before close, do them.
The default implementation of this function does nothing. This function can be overridden in custom classes.
Reimplemented from OdDbObject.
◆ subDeepClone()
|
protectedvirtual |
Reimplemented from OdDbEntity.
◆ subDeleteSubentPaths()
|
protectedvirtual |
Deletes one or more subentities from an entity.
- Parameters
-
paths [in] The array of OdDbFullSubentPath objects.
Reimplemented from OdDbEntity.
◆ subExplode()
|
protectedvirtual |
Reimplemented from OdDbEntity.
◆ subGetClassID()
Reimplemented from OdDbEntity.
◆ subGetGeomExtents()
|
protectedvirtual |
Reimplemented from OdDbEntity.
◆ subGetGsMarkersAtSubentPath()
|
protectedvirtual |
Returns all graphic system marker by subentity paths.
- Parameters
-
subPath [in] The OdDbFullSubentPath to the subentity. gsMarkers [in/out] The array of integer identifiers (GS markers).
Reimplemented from OdDbEntity.
◆ subGetSubentPathsAtGsMarker()
|
protectedvirtual |
Returns all subentity paths by graphic system marker.
- Parameters
-
type [in] The subentity type being queried. ( Only OdDb::kClassSubentType ) gsMarker [in] The GS marker of the subentity being queried. pickPoint [in] The WCS point being queried. ( Not used ) xrm [in] The WCS->DCS transformation matrix. ( Not used ) subentPaths [out] The array of OdDbFullSubentPath objects. entAndInsertStack [in] The array of objectIds of the objects that are the nested containers of the subentity.
Reimplemented from OdDbEntity.
◆ subGetTransformedCopy()
|
protectedvirtual |
Reimplemented from OdDbEntity.
◆ subMoveGripPointsAt()
|
protectedvirtual |
Reimplemented from OdDbEntity.
◆ subSetAttributes()
|
protectedvirtual |
Sets the values of this object's subentity traits, and returns with the calling object's subentity traits.
- Parameters
-
pTraits [in] Pointer to the OdGiDrawableTraits object to be set.
- Remarks
- When overriding subSetAttributes(), you must OR (|) the return value of <base class>::subSetAttributes(pTraits) with any flags you add.
A derived class may not remove flags for any reason.
The default implementation does nothing but returns kDrawableNone. This function can be overridden in custom classes.
Reimplemented from OdDbEntity.
◆ subSetDatabaseDefaults()
|
protectedvirtual |
Called by setDatabaseDefaults() after the values are set.
- Parameters
-
pDb [in] Pointer to the database whose default values are to be used. doSubents [in] Set to true if subentities should be processed
- Remarks
- If pDb is null, the database containing this entity is used.
This function allows custom classes to inspect and modify the values set by setDatabaseDefaults.
The default implementation of this function returns eNotApplicable. This function can be overridden in custom classes.
- Remarks
- This function is not intended to be called by the user.
Reimplemented from OdDbEntity.
◆ subSubentPtr()
|
protectedvirtual |
Create an object by OdDbFullSubentPath to the subentity.
- Parameters
-
path [in] The OdDbFullSubentPath to the subentity.
Reimplemented from OdDbEntity.
◆ subTransformBy()
|
protectedvirtual |
Reimplemented from OdDbEntity.
◆ subViewportDraw()
|
protectedvirtual |
Reimplemented from OdDbEntity.
◆ subWblockClone()
|
protectedvirtual |
Reimplemented from OdDbEntity.
◆ subWorldDraw()
|
protectedvirtual |
Reimplemented from OdDbEntity.
◆ textAlignmentType()
| OdDbMLeaderStyle::TextAlignmentType OdDbMLeader::textAlignmentType | ( | ) | const |
Returns the text alignment type for MText content.
◆ textAngleType()
| OdDbMLeaderStyle::TextAngleType OdDbMLeader::textAngleType | ( | ) | const |
Returns the angle type for MText content, with respect to the last leader line segment.
◆ textAttachmentDirection()
| OdDbMLeaderStyle::TextAttachmentDirection OdDbMLeader::textAttachmentDirection | ( | ) | const |
Returns the text attachment direction of MText.
◆ textAttachmentType()
| OdDbMLeaderStyle::TextAttachmentType OdDbMLeader::textAttachmentType | ( | OdDbMLeaderStyle::LeaderDirectionType | leaderDirection | ) | const |
Returns the text attachment type used by MText content.
- Parameters
-
leaderDirection [in] Text leader direction type.
◆ textColor()
| OdCmColor OdDbMLeader::textColor | ( | ) | const |
Returns the text color for MText content.
◆ textHeight()
| double OdDbMLeader::textHeight | ( | ) | const |
Returns the text height for MText content.
◆ textStyleId()
| OdDbObjectId OdDbMLeader::textStyleId | ( | ) | const |
Return the textstyle used by MText content (by ObjectId).
◆ updateContentScale()
| OdResult OdDbMLeader::updateContentScale | ( | OdDbMLeaderObjectContextData * | pContext | ) |
Updates this MLeaders's arrow head, landing gap, dog-leg length, and text height or block scale.
- Parameters
-
pContext [in] MLeader context data.
- Returns
- Returns eOk if successful.
◆ updateLeaderLinePosition()
| OdResult OdDbMLeader::updateLeaderLinePosition | ( | ) |
Updates leader line positions.
- Returns
- Returns eOk if successful.
The documentation for this class was generated from the following file: