DATAKIT API  V2025.4
Dtk_Welding Class Reference

This is the Welding Symbol class. More...

+ Inheritance diagram for Dtk_Welding:

Public Types

enum  ComplementarySymbolEnum {
  ComplementarySymbolNone = 0, ComplementarySymbolWeldWithFlatFace, ComplementarySymbolWeldWithConvexFace, ComplementarySymbolWeldWithConcaveFace,
  ComplementarySymbolFlushFinishedWeld, ComplementarySymbolFilletWeldWithSmoothBlendedFace
}
 
enum  FinishSymbolEnum {
  FinishSymbolNone = 0, FinishSymbolChip, FinishSymbolFlush, FinishSymbolGrind,
  FinishSymbolHammer, FinishSymbolMachine, FinishSymbolRoll, FinishSymbolPeening,
  FinishSymbolUnspecified
}
 
enum  WeldingSymbolEnum {
  SymbolNone = 0, SymbolSquareButtWeld, SymbolSingeVButtWeld, SymbolSingleBevelButtWeld,
  SymbolFlareVButtWeld, SymbolFlareBevelButtWeld, SymbolSingleUButtWeld, SymbolSingleJButtWeld,
  SymbolFilletWeld, SymbolSpotWeld, SymbolBackWeld, SymbolSteepFlankedSingleBevelButtWeld,
  SymbolSteepFlankedSingleVWeld, SymbolPlugWeld, SymbolRemovableBackingStripUsed, SymbolPermanentBackingStripUsed,
  SymbolSurfacingWeld, SymbolSeamWeld, SymbolFlangeEdge, SymbolStickWeld,
  SymbolFlangeCorner, SymbolVFlareWeld, SymbolFlareBevelWeld, SymbolScarfWeld,
  SymbolStudWeld, SymbolANSIEdgeWeld, SymbolISOEdgeWeld, SymbolSurfaceJointWeld,
  SymbolInclinedJointWeld, SymbolMeltThroughWeld, SymbolSolderedJointWeld, SymbolFoldJointWeld,
  SymbolKGrooveWeld, SymbolStakeWeld
}
 
enum  WeldTextType {
  WeldTextUndefinedType = 0, WeldTextFinishSymbol, WeldTextAngle, WeldTextNum,
  WeldTextLength, WeldTextSize, WeldTextDepth, WeldTextClearance,
  WeldTextSecondFilletSize, WeldTextSecondFilletLength, WeldTextOpening, WeldTextWeldSymbol
}
 

Public Member Functions

virtual Dtk_ErrorStatus _Store (void *)
 
void AddAdditionnalGeometries (const Dtk_tab< Dtk_EntityPtr > &inAdditionnalGeometries)
 Adds some additionnal geometries to the Dtk_2dEntity. More...
 
void AddAdditionnalGeometry (const Dtk_EntityPtr &inAdditionnalGeometry)
 Adds an additionnal geometry to the Dtk_2dEntity. More...
 
void AddAdditionnalTexts (Dtk_CompositeText inAddtionnalTexts)
 Adds some additionnal texts to the Dtk_2dEntity. More...
 
void AddArrowSideAssociatedGeometry (Dtk_EntityPtr inAssociatedGeometry)
 Add an AssociatedGeometry of the ArrowSide. More...
 
void AddArrowSideText (WeldTextType inType, Dtk_CompositeText inText)
 Add a Text and its type to the ArrowSide. More...
 
void AddArrowSideUndefinedText (Dtk_CompositeText inText)
 Add an undefined Text to the ArrowSide. More...
 
void AddAssociatedGeometries (Dtk_tab< Dtk_EntityPtr > inAssociatedGeometries)
 Add Geometries associated to whole Dtk_Welding (Weld body and tail). More...
 
void AddAssociatedGeometry (Dtk_EntityPtr inAssociatedGeometry)
 Add a Geometry associated to whole Dtk_Welding (Weld body and tail). More...
 
Dtk_ErrorStatus AddLeader (const Dtk_LeaderPtr &leader)
 Adds a leader to the Dtk_Annotation. More...
 
void AddOtherSideAssociatedGeometry (Dtk_EntityPtr inAssociatedGeometry)
 Add an AssociatedGeometry of the OtherSide. More...
 
void AddOtherSideText (WeldTextType inType, Dtk_CompositeText inText)
 Add a Text and its type to the OtherSide. More...
 
void AddOtherSideUndefinedText (Dtk_CompositeText inText)
 Add an undefined Text to the OtherSide. More...
 
Dtk_Int32 DtkDynamicType (const Dtk_Int32 &inId)
 Retrieves the dynamic entity type. More...
 
int DtkDynamicType (const int &inId)
 
virtual void dump (FILE *file=stdout)
 
Dtk_Char8 FinishSymbolToDtk_Text (const FinishSymbolEnum inFinishSymbol) const
 Convert FinishSymbolEnum to Dtk_Char8. More...
 
Dtk_InfoPtr get_info () const
 
type_detk get_type_detk () const
 
const Dtk_tab< Dtk_EntityPtr > & GetAdditionnalGeometries () const
 Retrieves the additionnal geometries of the Dtk_2dEntity. More...
 
const Dtk_CompositeTextGetAdditionnalTexts () const
 Retrieves the additionnal texts of the Dtk_2dEntity. More...
 
Dtk_ErrorStatus GetAnchorPoints (Dtk_pnt(&inTabPoints)[DTK_NB_ANCHOR_TYPES])
 
Dtk_ErrorStatus GetAnchorPoints (Dtk_pnt(&inTabPoints)[DTK_NB_ANCHOR_TYPES]) const
 Processes all the Dtk_Annotation anchor points. More...
 
Dtk_Text GetAngleTextArrowSide () const
 Retrieves the ArrowSide Angle Dtk_Text. More...
 
Dtk_Text GetAngleTextOtherSide () const
 Retrieves the OtherSide Angle Dtk_Text. More...
 
std::unordered_map< Dtk_UInt8, Dtk_CompositeTextGetArrowSideAllTexts () const
 Return all the texts of the ArrowSide. More...
 
Dtk_CompositeText GetArrowSideClearanceText () const
 Retrieves the ArrowSideClearanceText Dtk_CompositeText. More...
 
Dtk_CompositeText GetArrowSideDepthText () const
 Retrieves the ArrowSideDepthText Dtk_CompositeText. More...
 
Dtk_CompositeText GetArrowSideOpeningText () const
 Retrieves the ArrowSideOpeningText Dtk_CompositeText. More...
 
Dtk_CompositeText GetArrowSideSecondFilletLengthText () const
 Retrieves the ArrowSideSecondFilletLengthText Dtk_CompositeText. More...
 
Dtk_CompositeText GetArrowSideSecondFilletSizeText () const
 Retrieves the ArrowSideSecondFilletSizeText Dtk_CompositeText. More...
 
Dtk_CompositeText GetArrowSideSizeText () const
 Retrieves the ArrowSideSizeText Dtk_CompositeText. More...
 
Dtk_CompositeText GetArrowSideUndefinedText () const
 Retrieves the ArrowSideUndefinedText Dtk_CompositeText. More...
 
Dtk_CompositeText GetArrowSideWeldSymbolText () const
 Retrieves the ArrowSideWeldSymbolText Dtk_CompositeText. More...
 
Dtk_bool GetBrazingArrowSide () const
 Tells if the Brazing is activated for the ArrowSide. More...
 
Dtk_bool GetBrazingOtherSide () const
 Tells if the Brazing is activated for the OtherSide. More...
 
ComplementarySymbolEnum GetComplementarySymbolArrowSide () const
 Retrieves the ArrowSide WeldingSymboEnum. More...
 
ComplementarySymbolEnum GetComplementarySymbolOtherSide () const
 Retrieves the OtherSide WeldingSymboEnum. More...
 
Dtk_bool GetFieldWeldActivated () const
 Tells if the Field Weld Symbol is activated. More...
 
FinishSymbolEnum GetFinishSymbolArrowSide () const
 Retrieves the ArrowSide FinishSymbol as FinishSymbolEnum. More...
 
Dtk_Text GetFinishSymbolArrowSideAsText () const
 
FinishSymbolEnum GetFinishSymbolOtherSide () const
 Retrieves the OtherSide FinishSymbol as FinishSymbolEnum. More...
 
Dtk_Text GetFinishSymbolOtherSideAsText () const
 
Dtk_Text GetFinishSymbolTextArrowSide () const
 Retrieves the ArrowSide Finish Symbol Dtk_Text. More...
 
Dtk_Text GetFinishSymbolTextOtherSide () const
 Retrieves the OtherSide Finish Symbol Dtk_Text. More...
 
Dtk_tab< Dtk_EntityPtrGetGeometries (const Dtk_bool inIncludeWeldBodyGeometries=DTK_TRUE, const Dtk_bool inIncludeOtherSideGeometries=DTK_TRUE, const Dtk_bool inIncludeArrowSideGeometries=DTK_TRUE) const
 Retrieves the Dtk_Welding geometries. More...
 
const Dtk_IDGetID () const
 Get Internal UniqueID. More...
 
Dtk_Char8 GetIndentLineFlag () const
 Retrieves the IndentLine Flag. More...
 
Dtk_LeaderPtr GetLeader (const Dtk_Size_t &inPos) const
 Gets the i'th leader. More...
 
Dtk_Text GetLengthTextArrowSide () const
 Retrieves the ArrowSide Length Dtk_Text. More...
 
Dtk_Text GetLengthTextOtherSide () const
 Retrieves the OtherSide Length Dtk_Text. More...
 
virtual Dtk_pnt GetLocation () const
 Get the annoation location point. More...
 
const Dtk_anchor_typeGetLocationAnchorType () const
 Gets the location anchor type - read only -. More...
 
Dtk_Size_t GetNumLeaders () const
 Retrieves the number of leaders. More...
 
Dtk_Text GetNumWeldsTextArrowSide () const
 Retrieves the ArrowSide NumWelds Dtk_Text. More...
 
Dtk_Text GetNumWeldsTextOtherSide () const
 Retrieves the OtherSide NumWelds Dtk_Text. More...
 
Dtk_Double64 GetOffset () const
 Gets the annotation offset - read only -. More...
 
std::unordered_map< Dtk_UInt8, Dtk_CompositeTextGetOtherSideAllTexts () const
 Return all the texts of the OtherSide. More...
 
Dtk_CompositeText GetOtherSideClearanceText () const
 Retrieves the OtherSideClearanceText Dtk_CompositeText. More...
 
Dtk_CompositeText GetOtherSideDepthText () const
 Retrieves the OtherSideDepthText Dtk_CompositeText. More...
 
Dtk_CompositeText GetOtherSideOpeningText () const
 Retrieves the OtherSideOpeningText Dtk_CompositeText. More...
 
Dtk_CompositeText GetOtherSideSecondFilletLengthText () const
 Retrieves the OtherSideSecondFilletLengthText Dtk_CompositeText. More...
 
Dtk_CompositeText GetOtherSideSecondFilletSizeText () const
 Retrieves the OtherSideSecondFilletSizeText Dtk_CompositeText. More...
 
Dtk_CompositeText GetOtherSideSizeText () const
 Retrieves the OtherSideSizeText Dtk_CompositeText. More...
 
Dtk_CompositeText GetOtherSideUndefinedText () const
 Retrieves the OtherSideUndefinedText Dtk_CompositeText. More...
 
Dtk_CompositeText GetOtherSideWeldSymbolText () const
 Retrieves the OtherSideWeldSymbolText Dtk_CompositeText. More...
 
Dtk_bool GetReverseTailAndFieldFlag () const
 Tells if the Field/Tail are reversed. More...
 
Dtk_Double64 GetRotationAngle (const Dtk_dir &inXAxis=Dtk_dir(1, 0, 0), const Dtk_dir &inYAxis=Dtk_dir(0, 1, 0)) const
 Gets the text rotation angle giving a reference base. More...
 
virtual Dtk_Size_t GetSize () const
 
Dtk_Text GetSizeTextArrowSide () const
 Retrieves the ArrowSide Size Dtk_Text. More...
 
Dtk_Text GetSizeTextOtherSide () const
 Retrieves the OtherSide Size Dtk_Text. More...
 
Dtk_CompositeText GetTailText () const
 Retrieves the Tail Dtk_CompositeText. More...
 
WeldingSymbolEnum GetWeldingSymbolArrowSide () const
 Retrieves the ArrowSide WeldingSymboEnum. More...
 
WeldingSymbolEnum GetWeldingSymbolOtherSide () const
 Retrieves the OtherSide WeldingSymboEnum. More...
 
Dtk_bool GetWeldTailActivated () const
 Tells if the Weld Tail is activated. More...
 
Dtk_dir GetXAxis () const
 Get the X Axis - read only -. More...
 
Dtk_dir GetYAxis () const
 Get the Y Axis - read only -. More...
 
Dtk_InfoPtrinfo ()
 
Dtk_Weldingoperator= (const Dtk_Welding &in)
 Copy assignment operator. More...
 
virtual void PrepareTransfo ()
 
void ProcessSymbolInfos (Dtk_tab< Dtk_pnt > &outPnts) const
 Process the Welding Symbol Informations as shown in the picture below. More...
 
virtual Dtk_ErrorStatus Reverse ()
 Reverses the Dtk_Annotation. More...
 
Dtk_ErrorStatus SetAnchorPoint (const Dtk_pnt &inNewLocation, const Dtk_anchor_type &inLocationAnchorType)
 Sets the Dtk_Welding anchor point. More...
 
void SetArrowSideAssociatedGeometries (Dtk_tab< Dtk_EntityPtr > inAssociatedGeometries)
 Set the AssociatedGeometries of the ArrowSide. More...
 
void SetArrowSideClearanceText (Dtk_CompositeText inArrowSideClearanceText)
 Sets the ArrowSideClearanceText Dtk_CompositeText. More...
 
void SetArrowSideContourSymbol (ComplementarySymbolEnum inContourSymbol)
 Set the ContourSymbol of the ArrowSide. More...
 
void SetArrowSideData (const WeldingSymbolEnum inWeldingSymbol, Dtk_Text inNumWeldsText, Dtk_Text inAngleText, const ComplementarySymbolEnum inContourSymbol, Dtk_Text inFinishSymbolText, Dtk_Text inSizeText, Dtk_Text inLengthText, Dtk_tab< Dtk_EntityPtr > inAssociatedGeometries)
 Sets the Dtk_Welding ArrowSide Data. More...
 
void SetArrowSideDepthText (Dtk_CompositeText inArrowSideDepthText)
 Sets the ArrowSideDepthText Dtk_CompositeText. More...
 
void SetArrowSideOpeningText (Dtk_CompositeText inArrowSideOpeningText)
 Sets the ArrowSideOpeningText Dtk_CompositeText. More...
 
void SetArrowSideSecondFilletLengthText (Dtk_CompositeText inArrowSideSecondFilletLengthText)
 Sets the ArrowSideSecondFilletLengthText Dtk_CompositeText. More...
 
void SetArrowSideSecondFilletSizeText (Dtk_CompositeText inArrowSideSecondFilletSizeText)
 Sets the ArrowSideSecondFilletSizeText Dtk_CompositeText. More...
 
void SetArrowSideSizeText (Dtk_CompositeText inArrowSideSizeText)
 Sets the ArrowSideSizeText Dtk_CompositeText. More...
 
void SetArrowSideTexts (std::unordered_map< Dtk_UInt8, Dtk_CompositeText > &inTexts)
 Set the Dtk_Welding ArrowSide Texts and their types. More...
 
void SetArrowSideWeldingSymbol (WeldingSymbolEnum inWeldingSymbol)
 Set the WeldingSymbol of the ArrowSide. More...
 
void SetArrowSideWeldSymbolText (Dtk_CompositeText inArrowSideWeldSymbolText)
 Sets the ArrowSideWeldSymbolText Dtk_CompositeText. More...
 
 SetAsDeprecated ("Undefined", "Use Dtk_TextStyle::Justification()") Dtk_justication_type GetJustification() const
 Get the justification type - read only -. More...
 
void SetBrazingArrowSide (const Dtk_bool inBrazing=DTK_TRUE)
 Sets the Brazing flag for the ArrowSide. More...
 
void SetBrazingOtherSide (const Dtk_bool inBrazing=DTK_TRUE)
 Sets the Brazing flag for the OtherSide. More...
 
void SetFieldWeldFlag (const Dtk_bool inFieldWeldFlag)
 Sets the Field Weld Flag. More...
 
void SetIndentLineFlag (const Dtk_Char8 inIndentLineFlag=-1)
 Sets the IndentLine Flag. More...
 
Dtk_ErrorStatus SetLocation (const Dtk_pnt &inLocation)
 Sets the location point of the Dtk_Annotation. More...
 
Dtk_ErrorStatus SetLocation (const Dtk_pnt &location, const Dtk_anchor_type &inAnchorType)
 Sets the location point of the Dtk_Annotation. More...
 
Dtk_ErrorStatus SetOffset (const Dtk_Double64 &inOffset)
 Sets the offset of the Dtk_Welding. More...
 
void SetOtherSideAssociatedGeometries (Dtk_tab< Dtk_EntityPtr > inAssociatedGeometries)
 Set the AssociatedGeometries of the OtherSide. More...
 
void SetOtherSideClearanceText (Dtk_CompositeText inOtherSideClearanceText)
 Sets the OtherSideClearanceText Dtk_CompositeText. More...
 
void SetOtherSideContourSymbol (ComplementarySymbolEnum inContourSymbol)
 Set the ContourSymbol of the OtherSide. More...
 
void SetOtherSideData (const WeldingSymbolEnum inWeldingSymbol, Dtk_Text inNumWeldsText, Dtk_Text inAngleText, const ComplementarySymbolEnum inContourSymbol, Dtk_Text inFinishSymbolText, Dtk_Text inSizeText, Dtk_Text inLengthText, Dtk_tab< Dtk_EntityPtr > inAssociatedGeometries)
 Sets the Dtk_Welding OtherSide Data. More...
 
void SetOtherSideDepthText (Dtk_CompositeText inOtherSideDepthText)
 Sets the OtherSideDepthText Dtk_CompositeText. More...
 
void SetOtherSideOpeningText (Dtk_CompositeText inOtherSideOpeningText)
 Sets the OtherSideOpeningText Dtk_CompositeText. More...
 
void SetOtherSideSecondFilletLengthText (Dtk_CompositeText inOtherSideSecondFilletLengthText)
 Sets the OtherSideSecondFilletLengthText Dtk_CompositeText. More...
 
void SetOtherSideSecondFilletSizeText (Dtk_CompositeText inOtherSideSecondFilletSizeText)
 Sets the OtherSideSecondFilletSizeText Dtk_CompositeText. More...
 
void SetOtherSideSizeText (Dtk_CompositeText inOtherSideSizeText)
 Sets the OtherSideSizeText Dtk_CompositeText. More...
 
void SetOtherSideTexts (std::unordered_map< Dtk_UInt8, Dtk_CompositeText > &inTexts)
 Set the Dtk_Welding OtherSide Texts and their types. More...
 
void SetOtherSideWeldingSymbol (WeldingSymbolEnum inWeldingSymbol)
 Set the WeldingSymbol of the OtherSide. More...
 
void SetOtherSideWeldSymbolText (Dtk_CompositeText inOtherSideWeldSymbolText)
 Sets the OtherSideWeldSymbolText Dtk_CompositeText. More...
 
void SetReverseTailAndFieldFlag (const Dtk_bool inReverseTailAndField=DTK_TRUE)
 Sets the Field/Tail Reverse Flag. More...
 
Dtk_ErrorStatus SetRotationAngle (const Dtk_Double64 &inAngle)
 Sets the annotation angle using the annotation base. More...
 
void SetSymbolInfos (Dtk_tab< Dtk_pnt > &inPnts)
 Process the Welding Symbol Informations. More...
 
void SetTailText (Dtk_CompositeText inTailText)
 Sets the Tail Dtk_CompositeText. More...
 
void SetWeldTailActivated (const Dtk_bool inTailActivated=DTK_FALSE)
 Sets the Tail Activation Flag. More...
 
Dtk_ErrorStatus Transform (const Dtk_transfo &inTransfo)
 Applies a transformation matrix to the entity. //! More...
 

Static Public Member Functions

static Dtk_string ComplementarySymbolEnumToString (const ComplementarySymbolEnum &inEnum)
 
static Dtk_WeldingPtr Create ()
 Calls default constructor to allocate a new object. More...
 
static Dtk_WeldingPtr Create (const Dtk_pnt &inLocation, const Dtk_InfoPtr &inInfos, Dtk_tab< Dtk_LeaderPtr > inLeaders=Dtk_tab< Dtk_LeaderPtr >(), const Dtk_Double64 inAngle=0.0, const Dtk_Double64 inOffset=0.0, const Dtk_anchor_type inAnchorType=DTK_ANCHOR_BOTTOM_LEFT, const Dtk_justication_type inJustification=DTK_JUSTIFY_LEFT)
 Calls full featured constructor to allocate a new object. More...
 
static Dtk_WeldingPtr Create (const Dtk_pnt &inLocation, Dtk_CompositeText inTailText, const Dtk_bool inFieldWeldActivated, const Dtk_Char8 inIndentLineFlag, const Dtk_bool inTailActivated, const Dtk_bool inReverseTailAndField, const Dtk_InfoPtr &inInfos, Dtk_tab< Dtk_LeaderPtr > inLeaders, const Dtk_Double64 inAngle, const Dtk_Double64 inOffset, const Dtk_anchor_type inAnchorType, const Dtk_justication_type inJustification)
 Calls full featured constructor to allocate a new object. More...
 
static Dtk_WeldingPtr Create (const Dtk_Welding &in)
 Calls copy constructor to allocate a new object. More...
 
static Dtk_WeldingPtr Create (Dtk_Welding &&in)
 Calls move constructor to allocate a new object. More...
 
static Dtk_WeldingDtkDynamicCast (Dtk_Object *s)
 Performs a dynamic cast - doesn't need RTTI -. More...
 
static Dtk_string FinishSymbolEnumToString (const FinishSymbolEnum &inEnum)
 
static Dtk_string WeldingSymbolEnumToString (const WeldingSymbolEnum &inEnum)
 

Protected Types

enum  { _typeID = DTK_TYPE_2D_ENTITY }
 
enum  { _typeID = DTK_TYPE_ENTITY }
 
enum  { _typeID = DTK_TYPE_ANNOTATION }
 
enum  { _typeID = DTK_TYPE_WELDING }
 

Protected Member Functions

void _Copy (const Dtk_2dEntity &s)
 
void _copy (const Dtk_Entity &s)
 
void _init ()
 
void _reset ()
 
virtual Dtk_ObjectClone ()
 
 Dtk_Welding ()
 
 Dtk_Welding (const Dtk_pnt &inLocation, const Dtk_InfoPtr &inInfos, Dtk_tab< Dtk_LeaderPtr > inLeaders=Dtk_tab< Dtk_LeaderPtr >(), const Dtk_Double64 inAngle=0.0, const Dtk_Double64 inOffset=0.0, const Dtk_anchor_type inAnchor_type=DTK_ANCHOR_BOTTOM_LEFT, const Dtk_justication_type inJustification=DTK_JUSTIFY_LEFT)
 
 Dtk_Welding (const Dtk_pnt &inLocation, Dtk_CompositeText inMiddleRightText, const Dtk_bool inFieldWeldActivated, const Dtk_Char8 inIndentLineFlag, const Dtk_bool inTailActivated, const Dtk_bool inReverseTailAndField, const Dtk_InfoPtr &inInfos, Dtk_tab< Dtk_LeaderPtr > inLeaders, const Dtk_Double64 inAngle, const Dtk_Double64 inOffset, const Dtk_anchor_type inAnchorType, const Dtk_justication_type inJustification)
 
 Dtk_Welding (const Dtk_Welding &s)
 
 Dtk_Welding (Dtk_Welding &&s) DTK_NOEXCEPT
 
 ~Dtk_Welding ()
 Destructor. More...
 

Protected Attributes

Dtk_Handle * _Private
 
unsigned long count_
 

Detailed Description

This is the Welding Symbol class.

See also
Use Dtk_WeldingPtr class to handle it.


Member Enumeration Documentation

◆ anonymous enum

anonymous enum
protectedinherited
Enumerator
_typeID 

◆ anonymous enum

anonymous enum
protectedinherited
Enumerator
_typeID 

◆ anonymous enum

anonymous enum
protectedinherited
Enumerator
_typeID 

◆ anonymous enum

anonymous enum
protected
Enumerator
_typeID 

◆ ComplementarySymbolEnum

Enumerator
ComplementarySymbolNone 
ComplementarySymbolWeldWithFlatFace 
ComplementarySymbolWeldWithConvexFace 
ComplementarySymbolWeldWithConcaveFace 
ComplementarySymbolFlushFinishedWeld 
ComplementarySymbolFilletWeldWithSmoothBlendedFace 

◆ FinishSymbolEnum

Enumerator
FinishSymbolNone 
FinishSymbolChip 
FinishSymbolFlush 
FinishSymbolGrind 
FinishSymbolHammer 
FinishSymbolMachine 
FinishSymbolRoll 
FinishSymbolPeening 
FinishSymbolUnspecified 

◆ WeldingSymbolEnum

Enumerator
SymbolNone 
SymbolSquareButtWeld 
SymbolSingeVButtWeld 
SymbolSingleBevelButtWeld 
SymbolFlareVButtWeld 
SymbolFlareBevelButtWeld 
SymbolSingleUButtWeld 
SymbolSingleJButtWeld 
SymbolFilletWeld 
SymbolSpotWeld 
SymbolBackWeld 
SymbolSteepFlankedSingleBevelButtWeld 
SymbolSteepFlankedSingleVWeld 
SymbolPlugWeld 
SymbolRemovableBackingStripUsed 
SymbolPermanentBackingStripUsed 
SymbolSurfacingWeld 
SymbolSeamWeld 
SymbolFlangeEdge 
SymbolStickWeld 
SymbolFlangeCorner 
SymbolVFlareWeld 
SymbolFlareBevelWeld 
SymbolScarfWeld 
SymbolStudWeld 
SymbolANSIEdgeWeld 
SymbolISOEdgeWeld 
SymbolSurfaceJointWeld 
SymbolInclinedJointWeld 
SymbolMeltThroughWeld 
SymbolSolderedJointWeld 
SymbolFoldJointWeld 
SymbolKGrooveWeld 
SymbolStakeWeld 

◆ WeldTextType

Enumerator
WeldTextUndefinedType 
WeldTextFinishSymbol 
WeldTextAngle 
WeldTextNum 
WeldTextLength 
WeldTextSize 
WeldTextDepth 
WeldTextClearance 
WeldTextSecondFilletSize 
WeldTextSecondFilletLength 
WeldTextOpening 
WeldTextWeldSymbol 

Constructor & Destructor Documentation

◆ Dtk_Welding() [1/5]

Dtk_Welding::Dtk_Welding ( )
protected
See also
Create()

◆ Dtk_Welding() [2/5]

Dtk_Welding::Dtk_Welding ( const Dtk_pnt inLocation,
Dtk_CompositeText  inMiddleRightText,
const Dtk_bool  inFieldWeldActivated,
const Dtk_Char8  inIndentLineFlag,
const Dtk_bool  inTailActivated,
const Dtk_bool  inReverseTailAndField,
const Dtk_InfoPtr inInfos,
Dtk_tab< Dtk_LeaderPtr inLeaders,
const Dtk_Double64  inAngle,
const Dtk_Double64  inOffset,
const Dtk_anchor_type  inAnchorType,
const Dtk_justication_type  inJustification 
)
protected
See also
Create(const Dtk_pnt&, const Dtk_CompositeText&, const Dtk_bool, const Dtk_Char8, const Dtk_bool, const Dtk_bool, const Dtk_InfoPtr&, const Dtk_tab<Dtk_LeaderPtr>&, const Dtk_Double64, const Dtk_Double64, const Dtk_anchor_type, const Dtk_justication_type)

◆ Dtk_Welding() [3/5]

Dtk_Welding::Dtk_Welding ( const Dtk_pnt inLocation,
const Dtk_InfoPtr inInfos,
Dtk_tab< Dtk_LeaderPtr inLeaders = Dtk_tabDtk_LeaderPtr >(),
const Dtk_Double64  inAngle = 0.0,
const Dtk_Double64  inOffset = 0.0,
const Dtk_anchor_type  inAnchor_type = DTK_ANCHOR_BOTTOM_LEFT,
const Dtk_justication_type  inJustification = DTK_JUSTIFY_LEFT 
)
protected
See also
Create(const Dtk_pnt&, const Dtk_InfoPtr&, const Dtk_tab<Dtk_LeaderPtr>&, const Dtk_Double64, const Dtk_Double64, const Dtk_anchor_type, const Dtk_justication_type)

◆ Dtk_Welding() [4/5]

Dtk_Welding::Dtk_Welding ( const Dtk_Welding s)
protected

◆ Dtk_Welding() [5/5]

Dtk_Welding::Dtk_Welding ( Dtk_Welding &&  s)
protected

◆ ~Dtk_Welding()

Dtk_Welding::~Dtk_Welding ( )
protected

Destructor.

Member Function Documentation

◆ _Copy()

void Dtk_2dEntity::_Copy ( const Dtk_2dEntity s)
protectedinherited

◆ _copy()

void Dtk_Entity::_copy ( const Dtk_Entity s)
protectedinherited

◆ _init()

void Dtk_Entity::_init ( )
protectedinherited

◆ _reset()

void Dtk_Entity::_reset ( )
protectedinherited

◆ _Store()

◆ AddAdditionnalGeometries()

void Dtk_2dEntity::AddAdditionnalGeometries ( const Dtk_tab< Dtk_EntityPtr > &  inAdditionnalGeometries)
inherited

Adds some additionnal geometries to the Dtk_2dEntity.

Parameters
inAdditionnalGeometriesThe geometries to be added

◆ AddAdditionnalGeometry()

void Dtk_2dEntity::AddAdditionnalGeometry ( const Dtk_EntityPtr inAdditionnalGeometry)
inherited

Adds an additionnal geometry to the Dtk_2dEntity.

Parameters
inAdditionnalGeometryThe geometry to be added

◆ AddAdditionnalTexts()

void Dtk_2dEntity::AddAdditionnalTexts ( Dtk_CompositeText  inAddtionnalTexts)
inherited

Adds some additionnal texts to the Dtk_2dEntity.

Parameters
inAddtionnalTextsThe texts to be added

◆ AddArrowSideAssociatedGeometry()

void Dtk_Welding::AddArrowSideAssociatedGeometry ( Dtk_EntityPtr  inAssociatedGeometry)

Add an AssociatedGeometry of the ArrowSide.

Parameters
inAssociatedGeometryThe Geometry associated to the ArrowSide.

◆ AddArrowSideText()

void Dtk_Welding::AddArrowSideText ( WeldTextType  inType,
Dtk_CompositeText  inText 
)

Add a Text and its type to the ArrowSide.

Parameters
inTypeThe WeldTextType
inTextsThe text

◆ AddArrowSideUndefinedText()

void Dtk_Welding::AddArrowSideUndefinedText ( Dtk_CompositeText  inText)

Add an undefined Text to the ArrowSide.

Parameters
inTextsThe text

◆ AddAssociatedGeometries()

void Dtk_Welding::AddAssociatedGeometries ( Dtk_tab< Dtk_EntityPtr inAssociatedGeometries)

Add Geometries associated to whole Dtk_Welding (Weld body and tail).

Remarks
Used to Dtk_symbol convertion.
Parameters
inAssociatedGeometriesThe Geometries associated to the Dtk_Welding.

◆ AddAssociatedGeometry()

void Dtk_Welding::AddAssociatedGeometry ( Dtk_EntityPtr  inAssociatedGeometry)

Add a Geometry associated to whole Dtk_Welding (Weld body and tail).

Remarks
Used to Dtk_symbol convertion.
Parameters
inAssociatedGeometryThe Geometry associated to the Dtk_Welding.

◆ AddLeader()

Dtk_ErrorStatus Dtk_Annotation::AddLeader ( const Dtk_LeaderPtr leader)
inherited

Adds a leader to the Dtk_Annotation.

Parameters
leaderThe leader to be added
Returns
dtkNoError is OK
Remarks
If Added leader is NULL, so no leader is added.

◆ AddOtherSideAssociatedGeometry()

void Dtk_Welding::AddOtherSideAssociatedGeometry ( Dtk_EntityPtr  inAssociatedGeometry)

Add an AssociatedGeometry of the OtherSide.

Parameters
inAssociatedGeometryThe Geometry associated to the OtherSide.

◆ AddOtherSideText()

void Dtk_Welding::AddOtherSideText ( WeldTextType  inType,
Dtk_CompositeText  inText 
)

Add a Text and its type to the OtherSide.

Parameters
inTypeThe WeldTextType
inTextsThe text

◆ AddOtherSideUndefinedText()

void Dtk_Welding::AddOtherSideUndefinedText ( Dtk_CompositeText  inText)

Add an undefined Text to the OtherSide.

Parameters
inTextsThe text

◆ Clone()

virtual Dtk_Object* Dtk_Welding::Clone ( )
protectedvirtual

Implements Dtk_Annotation.

◆ ComplementarySymbolEnumToString()

static Dtk_string Dtk_Welding::ComplementarySymbolEnumToString ( const ComplementarySymbolEnum inEnum)
static

◆ Create() [1/5]

static Dtk_WeldingPtr Dtk_Welding::Create ( )
static

Calls default constructor to allocate a new object.

◆ Create() [2/5]

static Dtk_WeldingPtr Dtk_Welding::Create ( const Dtk_pnt inLocation,
const Dtk_InfoPtr inInfos,
Dtk_tab< Dtk_LeaderPtr inLeaders = Dtk_tabDtk_LeaderPtr >(),
const Dtk_Double64  inAngle = 0.0,
const Dtk_Double64  inOffset = 0.0,
const Dtk_anchor_type  inAnchorType = DTK_ANCHOR_BOTTOM_LEFT,
const Dtk_justication_type  inJustification = DTK_JUSTIFY_LEFT 
)
static

Calls full featured constructor to allocate a new object.

Parameters
inLocationPntThe Dtk_Welding location
inInfosDtk_Welding infos
inLeadersLeaders array.
inAngleAngle.
inOffSetOffset.
inAnchorTypeDtk_Welding anchor type.
inJustificationTypeJustification type.
Returns
The created Dtk_WeldingPtr

◆ Create() [3/5]

static Dtk_WeldingPtr Dtk_Welding::Create ( const Dtk_pnt inLocation,
Dtk_CompositeText  inTailText,
const Dtk_bool  inFieldWeldActivated,
const Dtk_Char8  inIndentLineFlag,
const Dtk_bool  inTailActivated,
const Dtk_bool  inReverseTailAndField,
const Dtk_InfoPtr inInfos,
Dtk_tab< Dtk_LeaderPtr inLeaders,
const Dtk_Double64  inAngle,
const Dtk_Double64  inOffset,
const Dtk_anchor_type  inAnchorType,
const Dtk_justication_type  inJustification 
)
static

Calls full featured constructor to allocate a new object.

Parameters
inLocationPntThe Dtk_Welding location
inTailTextTail Dtk_CompositeText.
inFieldWeldActivatedDTK_TRUE if Field is activated. DTK_FALSE else.
inIndentLineFlagThe IndentLineSideDown Flag:
  • -1 To disable Indent Line - default -.
  • 0 To set Indent Line to OtherSide - Up -.
  • 1 To set Indent Line to ArrowSide - Down -.
inTailActivatedThe Tail Flag Activation status. DTK_TRUE if activated DTK_FALSE else.
inReverseTailAndFieldThe Tail/Field Reverse Flag:
  • If DTK_TRUE the Field is at the left of the Dtk_Welding and the Tail is at Right.
  • If DTK_FALSE the Field and Tail are reversed - Field => Right and Tail => Left -.
inInfosDtk_Welding infos
inLeadersLeaders array.
inAngleAngle.
inOffSetOffset.
inAnchorTypeDtk_Welding anchor type.
inJustificationTypeJustification type.
Returns
The created Dtk_WeldingPtr

◆ Create() [4/5]

static Dtk_WeldingPtr Dtk_Welding::Create ( const Dtk_Welding in)
static

Calls copy constructor to allocate a new object.

Parameters
inObject to copy from.

◆ Create() [5/5]

static Dtk_WeldingPtr Dtk_Welding::Create ( Dtk_Welding &&  in)
static

Calls move constructor to allocate a new object.

Parameters
inObject to move from.

◆ DtkDynamicCast()

static Dtk_Welding* Dtk_Welding::DtkDynamicCast ( Dtk_Object s)
static

Performs a dynamic cast - doesn't need RTTI -.

◆ DtkDynamicType() [1/2]

Dtk_Int32 Dtk_Welding::DtkDynamicType ( const Dtk_Int32 inId)

Retrieves the dynamic entity type.

◆ DtkDynamicType() [2/2]

◆ dump()

virtual void Dtk_Object::dump ( FILE *  file = stdout)
virtualinherited

◆ FinishSymbolEnumToString()

static Dtk_string Dtk_Welding::FinishSymbolEnumToString ( const FinishSymbolEnum inEnum)
static

◆ FinishSymbolToDtk_Text()

Dtk_Char8 Dtk_Welding::FinishSymbolToDtk_Text ( const FinishSymbolEnum  inFinishSymbol) const

Convert FinishSymbolEnum to Dtk_Char8.

Parameters
inFinishSymbolFinishSymbolEnum to be converted.
Returns
Dtk_Char8 related to inFinishSymbol value.

◆ get_info()

Dtk_InfoPtr Dtk_Entity::get_info ( ) const
inherited

◆ get_type_detk()

type_detk Dtk_Welding::get_type_detk ( ) const
virtual
Returns
The type of the entity type - DTK_TYPE_WELDING -

Implements Dtk_Annotation.

◆ GetAdditionnalGeometries()

const Dtk_tab< Dtk_EntityPtr >& Dtk_2dEntity::GetAdditionnalGeometries ( ) const
inherited

Retrieves the additionnal geometries of the Dtk_2dEntity.

Returns
The additionnal geometries array - read only -.

◆ GetAdditionnalTexts()

const Dtk_CompositeText& Dtk_2dEntity::GetAdditionnalTexts ( ) const
inherited

Retrieves the additionnal texts of the Dtk_2dEntity.

Returns
The additionnal texts - read only -.

◆ GetAnchorPoints() [1/2]

Dtk_ErrorStatus Dtk_Welding::GetAnchorPoints ( Dtk_pnt(&)  inTabPoints[DTK_NB_ANCHOR_TYPES])

◆ GetAnchorPoints() [2/2]

Dtk_ErrorStatus Dtk_Welding::GetAnchorPoints ( Dtk_pnt(&)  outTabPnts[DTK_NB_ANCHOR_TYPES]) const
virtual

Processes all the Dtk_Annotation anchor points.

Parameters
outTabPntsThe resulting anchor point array.
Returns
dtkNoError if OK

Implements Dtk_Annotation.

◆ GetAngleTextArrowSide()

Dtk_Text Dtk_Welding::GetAngleTextArrowSide ( ) const

Retrieves the ArrowSide Angle Dtk_Text.

Returns
The ArrowSide Angle Dtk_Text.

◆ GetAngleTextOtherSide()

Dtk_Text Dtk_Welding::GetAngleTextOtherSide ( ) const

Retrieves the OtherSide Angle Dtk_Text.

Returns
The OtherSide Angle Dtk_Text.

◆ GetArrowSideAllTexts()

std::unordered_map<Dtk_UInt8, Dtk_CompositeText> Dtk_Welding::GetArrowSideAllTexts ( ) const

Return all the texts of the ArrowSide.

Returns
A map with WeldTextType keys and Dtk_CompositeText

◆ GetArrowSideClearanceText()

Dtk_CompositeText Dtk_Welding::GetArrowSideClearanceText ( ) const

Retrieves the ArrowSideClearanceText Dtk_CompositeText.

Returns
The ArrowSideClearanceText Dtk_CompositeText.

◆ GetArrowSideDepthText()

Dtk_CompositeText Dtk_Welding::GetArrowSideDepthText ( ) const

Retrieves the ArrowSideDepthText Dtk_CompositeText.

Returns
The ArrowSideDepthText Dtk_CompositeText.

◆ GetArrowSideOpeningText()

Dtk_CompositeText Dtk_Welding::GetArrowSideOpeningText ( ) const

Retrieves the ArrowSideOpeningText Dtk_CompositeText.

Returns
The ArrowSideOpeningText Dtk_CompositeText.

◆ GetArrowSideSecondFilletLengthText()

Dtk_CompositeText Dtk_Welding::GetArrowSideSecondFilletLengthText ( ) const

Retrieves the ArrowSideSecondFilletLengthText Dtk_CompositeText.

Returns
The ArrowSideSecondFilletLengthText Dtk_CompositeText.

◆ GetArrowSideSecondFilletSizeText()

Dtk_CompositeText Dtk_Welding::GetArrowSideSecondFilletSizeText ( ) const

Retrieves the ArrowSideSecondFilletSizeText Dtk_CompositeText.

Returns
The ArrowSideSecondFilletSizeText Dtk_CompositeText.

◆ GetArrowSideSizeText()

Dtk_CompositeText Dtk_Welding::GetArrowSideSizeText ( ) const

Retrieves the ArrowSideSizeText Dtk_CompositeText.

Returns
The ArrowSideSizeText Dtk_CompositeText.

◆ GetArrowSideUndefinedText()

Dtk_CompositeText Dtk_Welding::GetArrowSideUndefinedText ( ) const

Retrieves the ArrowSideUndefinedText Dtk_CompositeText.

Returns
The ArrowSideUndefinedText Dtk_CompositeText.

◆ GetArrowSideWeldSymbolText()

Dtk_CompositeText Dtk_Welding::GetArrowSideWeldSymbolText ( ) const

Retrieves the ArrowSideWeldSymbolText Dtk_CompositeText.

Returns
The ArrowSideWeldSymbolText Dtk_CompositeText.

◆ GetBrazingArrowSide()

Dtk_bool Dtk_Welding::GetBrazingArrowSide ( ) const

Tells if the Brazing is activated for the ArrowSide.

Returns
DTK_TRUE if the Brazing is activated, and the corresponding geometry should be in the _AssociatedGeometries, DTK_FALSE otherwise

◆ GetBrazingOtherSide()

Dtk_bool Dtk_Welding::GetBrazingOtherSide ( ) const

Tells if the Brazing is activated for the OtherSide.

Returns
DTK_TRUE if the Brazing is activated, and the corresponding geometry should be in the _AssociatedGeometries, DTK_FALSE otherwise

◆ GetComplementarySymbolArrowSide()

ComplementarySymbolEnum Dtk_Welding::GetComplementarySymbolArrowSide ( ) const

Retrieves the ArrowSide WeldingSymboEnum.

Returns
The ArrowSide WeldingSymboEnum.

◆ GetComplementarySymbolOtherSide()

ComplementarySymbolEnum Dtk_Welding::GetComplementarySymbolOtherSide ( ) const

Retrieves the OtherSide WeldingSymboEnum.

Returns
The OtherSide WeldingSymboEnum.

◆ GetFieldWeldActivated()

Dtk_bool Dtk_Welding::GetFieldWeldActivated ( ) const

Tells if the Field Weld Symbol is activated.

Returns
DTK_TRUE if Field Weld Symbol is activated. DTK_FALSE else.

◆ GetFinishSymbolArrowSide()

FinishSymbolEnum Dtk_Welding::GetFinishSymbolArrowSide ( ) const

Retrieves the ArrowSide FinishSymbol as FinishSymbolEnum.

Returns
The ArrowSide FinishSymbol as FinishSymbolEnum.

◆ GetFinishSymbolArrowSideAsText()

Dtk_Text Dtk_Welding::GetFinishSymbolArrowSideAsText ( ) const

◆ GetFinishSymbolOtherSide()

FinishSymbolEnum Dtk_Welding::GetFinishSymbolOtherSide ( ) const

Retrieves the OtherSide FinishSymbol as FinishSymbolEnum.

Returns
The OtherSide FinishSymbol as FinishSymbolEnum.

◆ GetFinishSymbolOtherSideAsText()

Dtk_Text Dtk_Welding::GetFinishSymbolOtherSideAsText ( ) const

◆ GetFinishSymbolTextArrowSide()

Dtk_Text Dtk_Welding::GetFinishSymbolTextArrowSide ( ) const

Retrieves the ArrowSide Finish Symbol Dtk_Text.

Returns
The ArrowSide Finish Symbol Dtk_Text.

◆ GetFinishSymbolTextOtherSide()

Dtk_Text Dtk_Welding::GetFinishSymbolTextOtherSide ( ) const

Retrieves the OtherSide Finish Symbol Dtk_Text.

Returns
The OtherSide Finish Symbol Dtk_Text.

◆ GetGeometries()

Dtk_tab< Dtk_EntityPtr > Dtk_Welding::GetGeometries ( const Dtk_bool  inIncludeWeldBodyGeometries = DTK_TRUE,
const Dtk_bool  inIncludeOtherSideGeometries = DTK_TRUE,
const Dtk_bool  inIncludeArrowSideGeometries = DTK_TRUE 
) const

Retrieves the Dtk_Welding geometries.

Parameters
inIncludeWeldBodyGeometriesIf DTK_TRUE includes WeldBody geometries - DTK_TRUE by default -.
inIncludeOtherSideGeometriesIf DTK_TRUE includes OtherSide geometries - DTK_TRUE by default -.
inIncludeArrowSideGeometriesIf DTK_TRUE includes ArrowSide geometries - DTK_TRUE by default -.
Returns
All the associated geometries asked.

◆ GetID()

const Dtk_ID& Dtk_Entity::GetID ( ) const
inherited

Get Internal UniqueID.

Returns
InternalID

◆ GetIndentLineFlag()

Dtk_Char8 Dtk_Welding::GetIndentLineFlag ( ) const

Retrieves the IndentLine Flag.

Returns
-1 if no Indent Line.
0 if Indent Line set at the OtherSide - Up -.
1 if Indent Line set at the ArrowSide - Down -.

◆ GetLeader()

Dtk_LeaderPtr Dtk_Annotation::GetLeader ( const Dtk_Size_t inPos) const
inherited

Gets the i'th leader.

Parameters
inPosThe leader position - 0 indexed -
Returns
The inPos'th leader

◆ GetLengthTextArrowSide()

Dtk_Text Dtk_Welding::GetLengthTextArrowSide ( ) const

Retrieves the ArrowSide Length Dtk_Text.

Returns
The ArrowSide Length Dtk_Text.

◆ GetLengthTextOtherSide()

Dtk_Text Dtk_Welding::GetLengthTextOtherSide ( ) const

Retrieves the OtherSide Length Dtk_Text.

Returns
The OtherSide Length Dtk_Text.

◆ GetLocation()

virtual Dtk_pnt Dtk_Annotation::GetLocation ( ) const
virtualinherited

Get the annoation location point.

Returns
The location point

◆ GetLocationAnchorType()

const Dtk_anchor_type& Dtk_Annotation::GetLocationAnchorType ( ) const
inherited

Gets the location anchor type - read only -.

Returns
The location anchor type.

◆ GetNumLeaders()

Dtk_Size_t Dtk_Annotation::GetNumLeaders ( ) const
inherited

Retrieves the number of leaders.

Returns
The number of leaders

◆ GetNumWeldsTextArrowSide()

Dtk_Text Dtk_Welding::GetNumWeldsTextArrowSide ( ) const

Retrieves the ArrowSide NumWelds Dtk_Text.

Returns
The ArrowSide NumWelds Dtk_Text.

◆ GetNumWeldsTextOtherSide()

Dtk_Text Dtk_Welding::GetNumWeldsTextOtherSide ( ) const

Retrieves the OtherSide NumWelds Dtk_Text.

Returns
The OtherSide NumWelds Dtk_Text.

◆ GetOffset()

Dtk_Double64 Dtk_Annotation::GetOffset ( ) const
inherited

Gets the annotation offset - read only -.

Returns
The annotation offset.
Warning
For internal use only

◆ GetOtherSideAllTexts()

std::unordered_map<Dtk_UInt8, Dtk_CompositeText> Dtk_Welding::GetOtherSideAllTexts ( ) const

Return all the texts of the OtherSide.

Returns
A map with WeldTextType keys and Dtk_CompositeText

◆ GetOtherSideClearanceText()

Dtk_CompositeText Dtk_Welding::GetOtherSideClearanceText ( ) const

Retrieves the OtherSideClearanceText Dtk_CompositeText.

Returns
The OtherSideClearanceText Dtk_CompositeText.

◆ GetOtherSideDepthText()

Dtk_CompositeText Dtk_Welding::GetOtherSideDepthText ( ) const

Retrieves the OtherSideDepthText Dtk_CompositeText.

Returns
The OtherSideDepthText Dtk_CompositeText.

◆ GetOtherSideOpeningText()

Dtk_CompositeText Dtk_Welding::GetOtherSideOpeningText ( ) const

Retrieves the OtherSideOpeningText Dtk_CompositeText.

Returns
The OtherSideOpeningText Dtk_CompositeText.

◆ GetOtherSideSecondFilletLengthText()

Dtk_CompositeText Dtk_Welding::GetOtherSideSecondFilletLengthText ( ) const

Retrieves the OtherSideSecondFilletLengthText Dtk_CompositeText.

Returns
The OtherSideSecondFilletLengthText Dtk_CompositeText.

◆ GetOtherSideSecondFilletSizeText()

Dtk_CompositeText Dtk_Welding::GetOtherSideSecondFilletSizeText ( ) const

Retrieves the OtherSideSecondFilletSizeText Dtk_CompositeText.

Returns
The OtherSideSecondFilletSizeText Dtk_CompositeText.

◆ GetOtherSideSizeText()

Dtk_CompositeText Dtk_Welding::GetOtherSideSizeText ( ) const

Retrieves the OtherSideSizeText Dtk_CompositeText.

Returns
The OtherSideSizeText Dtk_CompositeText.

◆ GetOtherSideUndefinedText()

Dtk_CompositeText Dtk_Welding::GetOtherSideUndefinedText ( ) const

Retrieves the OtherSideUndefinedText Dtk_CompositeText.

Returns
The OtherSideUndefinedText Dtk_CompositeText.

◆ GetOtherSideWeldSymbolText()

Dtk_CompositeText Dtk_Welding::GetOtherSideWeldSymbolText ( ) const

Retrieves the OtherSideWeldSymbolText Dtk_CompositeText.

Returns
The OtherSideWeldSymbolText Dtk_CompositeText.

◆ GetReverseTailAndFieldFlag()

Dtk_bool Dtk_Welding::GetReverseTailAndFieldFlag ( ) const

Tells if the Field/Tail are reversed.

Returns
DTK_FALSE if Field/Tail not reversed - Filed to the Left and Tail to the Right -.
DTK_TRUE if Field/Tail reversed.

◆ GetRotationAngle()

Dtk_Double64 Dtk_Annotation::GetRotationAngle ( const Dtk_dir inXAxis = Dtk_dir(1, 0, 0),
const Dtk_dir inYAxis = Dtk_dir(0, 1, 0) 
) const
inherited

Gets the text rotation angle giving a reference base.

Parameters
inXAxisThe reference X Axis - default value = (1,0,0) -
inYAxisThe reference Y Axis - default value = (0,1,0) -
Returns
The rotation angle.

◆ GetSize()

◆ GetSizeTextArrowSide()

Dtk_Text Dtk_Welding::GetSizeTextArrowSide ( ) const

Retrieves the ArrowSide Size Dtk_Text.

Returns
The ArrowSide Size Dtk_Text.

◆ GetSizeTextOtherSide()

Dtk_Text Dtk_Welding::GetSizeTextOtherSide ( ) const

Retrieves the OtherSide Size Dtk_Text.

Returns
The OtherSide Size Dtk_Text.

◆ GetTailText()

Dtk_CompositeText Dtk_Welding::GetTailText ( ) const

Retrieves the Tail Dtk_CompositeText.

Returns
The Tail Dtk_CompositeText.

◆ GetWeldingSymbolArrowSide()

WeldingSymbolEnum Dtk_Welding::GetWeldingSymbolArrowSide ( ) const

Retrieves the ArrowSide WeldingSymboEnum.

Returns
The ArrowSide WeldingSymboEnum.

◆ GetWeldingSymbolOtherSide()

WeldingSymbolEnum Dtk_Welding::GetWeldingSymbolOtherSide ( ) const

Retrieves the OtherSide WeldingSymboEnum.

Returns
The OtherSide WeldingSymboEnum.

◆ GetWeldTailActivated()

Dtk_bool Dtk_Welding::GetWeldTailActivated ( ) const

Tells if the Weld Tail is activated.

Returns
DTK_FALSE if no Tail.
DTK_TRUE if Tail is activated.

◆ GetXAxis()

Dtk_dir Dtk_Annotation::GetXAxis ( ) const
inherited

Get the X Axis - read only -.

Returns
The X Axis.

◆ GetYAxis()

Dtk_dir Dtk_Annotation::GetYAxis ( ) const
inherited

Get the Y Axis - read only -.

Returns
The Y Axis.

◆ info()

Dtk_InfoPtr& Dtk_Entity::info ( )
inherited

◆ operator=()

Dtk_Welding& Dtk_Welding::operator= ( const Dtk_Welding in)

Copy assignment operator.

Parameters
inObject to copy from.

◆ PrepareTransfo()

virtual void Dtk_Entity::PrepareTransfo ( )
virtualinherited

Reimplemented in Dtk_OffsetSurface.

◆ ProcessSymbolInfos()

void Dtk_Welding::ProcessSymbolInfos ( Dtk_tab< Dtk_pnt > &  outPnts) const

Process the Welding Symbol Informations as shown in the picture below.

Parameters
outPntsThe reference points processed.
Remarks
The 1st point is the Field point.
The 2nd point is the Tail point.

◆ Reverse()

virtual Dtk_ErrorStatus Dtk_Annotation::Reverse ( )
virtualinherited

Reverses the Dtk_Annotation.

Reimplemented in Dtk_DatumTarget.

◆ SetAnchorPoint()

Dtk_ErrorStatus Dtk_Welding::SetAnchorPoint ( const Dtk_pnt inNewLocation,
const Dtk_anchor_type inLocationAnchorType 
)
virtual

Sets the Dtk_Welding anchor point.

Parameters
inNewLocationThe new location point.
inLocationAnchorTypeThe anchor type related to the new location.
Returns
dtkNoError if OK

Implements Dtk_Annotation.

◆ SetArrowSideAssociatedGeometries()

void Dtk_Welding::SetArrowSideAssociatedGeometries ( Dtk_tab< Dtk_EntityPtr inAssociatedGeometries)

Set the AssociatedGeometries of the ArrowSide.

Parameters
inAssociatedGeometriesThe Geometries associated to the ArrowSide.

◆ SetArrowSideClearanceText()

void Dtk_Welding::SetArrowSideClearanceText ( Dtk_CompositeText  inArrowSideClearanceText)

Sets the ArrowSideClearanceText Dtk_CompositeText.

Parameters
inArrowSideClearanceTextThe Tail Dtk_CompositeText.

◆ SetArrowSideContourSymbol()

void Dtk_Welding::SetArrowSideContourSymbol ( ComplementarySymbolEnum  inContourSymbol)

Set the ContourSymbol of the ArrowSide.

Parameters
inContourSymbolThe Contour Symbol.

◆ SetArrowSideData()

void Dtk_Welding::SetArrowSideData ( const WeldingSymbolEnum  inWeldingSymbol,
Dtk_Text  inNumWeldsText,
Dtk_Text  inAngleText,
const ComplementarySymbolEnum  inContourSymbol,
Dtk_Text  inFinishSymbolText,
Dtk_Text  inSizeText,
Dtk_Text  inLengthText,
Dtk_tab< Dtk_EntityPtr inAssociatedGeometries 
)

Sets the Dtk_Welding ArrowSide Data.

Parameters
inWeldingSymbolThe Welding Symbol.
inNumWeldsTextThe NumWelds Dtk_Text.
inAngleTextThe Angle Dtk_Text.
inContourSymbolThe Contour Symbol.
inFinishSymbolTextThe Finish Symbol Dtk_Text.
inSizeTextThe Size Dtk_Text.
inLengthTextThe Length Dtk_Text.
inAssociatedGeometriesThe Geometries associated to the ArrowSide - used to Dtk_Symbol convertion -.

◆ SetArrowSideDepthText()

void Dtk_Welding::SetArrowSideDepthText ( Dtk_CompositeText  inArrowSideDepthText)

Sets the ArrowSideDepthText Dtk_CompositeText.

Parameters
inArrowSideDepthTextThe Tail Dtk_CompositeText.

◆ SetArrowSideOpeningText()

void Dtk_Welding::SetArrowSideOpeningText ( Dtk_CompositeText  inArrowSideOpeningText)

Sets the ArrowSideOpeningText Dtk_CompositeText.

Parameters
inArrowSideOpeningTextThe Tail Dtk_CompositeText.

◆ SetArrowSideSecondFilletLengthText()

void Dtk_Welding::SetArrowSideSecondFilletLengthText ( Dtk_CompositeText  inArrowSideSecondFilletLengthText)

Sets the ArrowSideSecondFilletLengthText Dtk_CompositeText.

Parameters
inArrowSideSecondFilletLengthTextThe Tail Dtk_CompositeText.

◆ SetArrowSideSecondFilletSizeText()

void Dtk_Welding::SetArrowSideSecondFilletSizeText ( Dtk_CompositeText  inArrowSideSecondFilletSizeText)

Sets the ArrowSideSecondFilletSizeText Dtk_CompositeText.

Parameters
inArrowSideSecondFilletSizeTextThe Tail Dtk_CompositeText.

◆ SetArrowSideSizeText()

void Dtk_Welding::SetArrowSideSizeText ( Dtk_CompositeText  inArrowSideSizeText)

Sets the ArrowSideSizeText Dtk_CompositeText.

Parameters
inArrowSideSizeTextThe Tail Dtk_CompositeText.

◆ SetArrowSideTexts()

void Dtk_Welding::SetArrowSideTexts ( std::unordered_map< Dtk_UInt8, Dtk_CompositeText > &  inTexts)

Set the Dtk_Welding ArrowSide Texts and their types.

Parameters
inTextsMap of texts with their corresponding WeldTextType

◆ SetArrowSideWeldingSymbol()

void Dtk_Welding::SetArrowSideWeldingSymbol ( WeldingSymbolEnum  inWeldingSymbol)

Set the WeldingSymbol of the ArrowSide.

Parameters
inWeldingSymbolThe Welding Symbol.

◆ SetArrowSideWeldSymbolText()

void Dtk_Welding::SetArrowSideWeldSymbolText ( Dtk_CompositeText  inArrowSideWeldSymbolText)

Sets the ArrowSideWeldSymbolText Dtk_CompositeText.

Parameters
inArrowSideWeldSymbolTextThe Tail Dtk_CompositeText.

◆ SetAsDeprecated()

Dtk_Annotation::SetAsDeprecated ( "Undefined"  ,
"Use Dtk_TextStyle::Justification()"   
) const
inherited

Get the justification type - read only -.

Returns
The justification type
Deprecated:
use the Dtk_TextStyle::Justification() instead

◆ SetBrazingArrowSide()

void Dtk_Welding::SetBrazingArrowSide ( const Dtk_bool  inBrazing = DTK_TRUE)

Sets the Brazing flag for the ArrowSide.

Parameters
inBrazingThe Brazing Flag.

◆ SetBrazingOtherSide()

void Dtk_Welding::SetBrazingOtherSide ( const Dtk_bool  inBrazing = DTK_TRUE)

Sets the Brazing flag for the OtherSide.

Parameters
inBrazingThe Brazing Flag.

◆ SetFieldWeldFlag()

void Dtk_Welding::SetFieldWeldFlag ( const Dtk_bool  inFieldWeldFlag)

Sets the Field Weld Flag.

Parameters
inFieldWeldFlagThe Field Weld Flag. DTK_TRUE if Field Weld is activated. DTK_TRUE else.

◆ SetIndentLineFlag()

void Dtk_Welding::SetIndentLineFlag ( const Dtk_Char8  inIndentLineFlag = -1)

Sets the IndentLine Flag.

Parameters
inIndentLineFlagThe IndentLine Flag:
  • -1 To disable Indent Line - default -.
  • 0 To set Indent Line to OtherSide - Up -.
  • 1 To set Indent Line to ArrowSide - Down -.

◆ SetLocation() [1/2]

Dtk_ErrorStatus Dtk_Welding::SetLocation ( const Dtk_pnt inLocation)
virtual

Sets the location point of the Dtk_Annotation.

The location point is related to the anchor type

Parameters
inLocationthe location point
Returns
dtkNoError if OK

Implements Dtk_Annotation.

◆ SetLocation() [2/2]

Dtk_ErrorStatus Dtk_Annotation::SetLocation ( const Dtk_pnt location,
const Dtk_anchor_type inAnchorType 
)
inherited

Sets the location point of the Dtk_Annotation.

The location point is related to the anchor type

Parameters
locationthe location point
inAnchorTypeThe anchor type related to the new location.
Returns
dtkNoError if OK

◆ SetOffset()

Dtk_ErrorStatus Dtk_Welding::SetOffset ( const Dtk_Double64 inOffset)
virtual

Sets the offset of the Dtk_Welding.

The Offset is used to process bounding frames.

Parameters
inOffsetThe offset
Returns
dtkNoError if OK
Warning
For internal use only

Implements Dtk_Annotation.

◆ SetOtherSideAssociatedGeometries()

void Dtk_Welding::SetOtherSideAssociatedGeometries ( Dtk_tab< Dtk_EntityPtr inAssociatedGeometries)

Set the AssociatedGeometries of the OtherSide.

Parameters
inAssociatedGeometriesThe Geometries associated to the OtherSide.

◆ SetOtherSideClearanceText()

void Dtk_Welding::SetOtherSideClearanceText ( Dtk_CompositeText  inOtherSideClearanceText)

Sets the OtherSideClearanceText Dtk_CompositeText.

Parameters
inOtherSideClearanceTextThe Tail Dtk_CompositeText.

◆ SetOtherSideContourSymbol()

void Dtk_Welding::SetOtherSideContourSymbol ( ComplementarySymbolEnum  inContourSymbol)

Set the ContourSymbol of the OtherSide.

Parameters
inContourSymbolThe Contour Symbol.

◆ SetOtherSideData()

void Dtk_Welding::SetOtherSideData ( const WeldingSymbolEnum  inWeldingSymbol,
Dtk_Text  inNumWeldsText,
Dtk_Text  inAngleText,
const ComplementarySymbolEnum  inContourSymbol,
Dtk_Text  inFinishSymbolText,
Dtk_Text  inSizeText,
Dtk_Text  inLengthText,
Dtk_tab< Dtk_EntityPtr inAssociatedGeometries 
)

Sets the Dtk_Welding OtherSide Data.

Parameters
inWeldingSymbolThe Welding Symbol.
inNumWeldsTextThe NumWelds Dtk_Text.
inAngleTextThe Angle Dtk_Text.
inContourSymbolThe Contour Symbol.
inFinishSymbolTextThe Finish Symbol Dtk_Text.
inSizeTextThe Size Dtk_Text.
inLengthTextThe Length Dtk_Text.
inAssociatedGeometriesThe Geometries associated to the OtherSide - used to Dtk_Symbol convertion -.

◆ SetOtherSideDepthText()

void Dtk_Welding::SetOtherSideDepthText ( Dtk_CompositeText  inOtherSideDepthText)

Sets the OtherSideDepthText Dtk_CompositeText.

Parameters
inOtherSideDepthTextThe Tail Dtk_CompositeText.

◆ SetOtherSideOpeningText()

void Dtk_Welding::SetOtherSideOpeningText ( Dtk_CompositeText  inOtherSideOpeningText)

Sets the OtherSideOpeningText Dtk_CompositeText.

Parameters
inOtherSideOpeningTextThe Tail Dtk_CompositeText.

◆ SetOtherSideSecondFilletLengthText()

void Dtk_Welding::SetOtherSideSecondFilletLengthText ( Dtk_CompositeText  inOtherSideSecondFilletLengthText)

Sets the OtherSideSecondFilletLengthText Dtk_CompositeText.

Parameters
inOtherSideSecondFilletLengthTextThe Tail Dtk_CompositeText.

◆ SetOtherSideSecondFilletSizeText()

void Dtk_Welding::SetOtherSideSecondFilletSizeText ( Dtk_CompositeText  inOtherSideSecondFilletSizeText)

Sets the OtherSideSecondFilletSizeText Dtk_CompositeText.

Parameters
inOtherSideSecondFilletSizeTextThe Tail Dtk_CompositeText.

◆ SetOtherSideSizeText()

void Dtk_Welding::SetOtherSideSizeText ( Dtk_CompositeText  inOtherSideSizeText)

Sets the OtherSideSizeText Dtk_CompositeText.

Parameters
inOtherSideSizeTextThe Tail Dtk_CompositeText.

◆ SetOtherSideTexts()

void Dtk_Welding::SetOtherSideTexts ( std::unordered_map< Dtk_UInt8, Dtk_CompositeText > &  inTexts)

Set the Dtk_Welding OtherSide Texts and their types.

Parameters
inTextsMap of texts with their corresponding WeldTextType

◆ SetOtherSideWeldingSymbol()

void Dtk_Welding::SetOtherSideWeldingSymbol ( WeldingSymbolEnum  inWeldingSymbol)

Set the WeldingSymbol of the OtherSide.

Parameters
inWeldingSymbolThe Welding Symbol.

◆ SetOtherSideWeldSymbolText()

void Dtk_Welding::SetOtherSideWeldSymbolText ( Dtk_CompositeText  inOtherSideWeldSymbolText)

Sets the OtherSideWeldSymbolText Dtk_CompositeText.

Parameters
inOtherSideWeldSymbolTextThe Tail Dtk_CompositeText.

◆ SetReverseTailAndFieldFlag()

void Dtk_Welding::SetReverseTailAndFieldFlag ( const Dtk_bool  inReverseTailAndField = DTK_TRUE)

Sets the Field/Tail Reverse Flag.

Parameters
inReverseTailAndFieldThe Tail/Field Reverse Flag:
  • If DTK_TRUE the Field is at the left of the Dtk_Welding and the Tail is at Right - default value -.
  • If DTK_FALSE the Field and Tail are reversed - Field => Right and Tail => Left -.

◆ SetRotationAngle()

Dtk_ErrorStatus Dtk_Welding::SetRotationAngle ( const Dtk_Double64 inAngle)
virtual

Sets the annotation angle using the annotation base.

Parameters
inRotationAngleThe rotation angle to be set
Returns
dtkNoError if OK

Reimplemented from Dtk_Annotation.

◆ SetSymbolInfos()

void Dtk_Welding::SetSymbolInfos ( Dtk_tab< Dtk_pnt > &  inPnts)

Process the Welding Symbol Informations.

Parameters
inPntsThe reference points.
Remarks
The 1st point is the Field point.
The 2nd point is the Tail point.

◆ SetTailText()

void Dtk_Welding::SetTailText ( Dtk_CompositeText  inTailText)

Sets the Tail Dtk_CompositeText.

Parameters
inTailTextThe Tail Dtk_CompositeText.

◆ SetWeldTailActivated()

void Dtk_Welding::SetWeldTailActivated ( const Dtk_bool  inTailActivated = DTK_FALSE)

Sets the Tail Activation Flag.

Parameters
inTailActivatedThe Tail Flag. If DTK_FALSE - default value - the Tail is not activated. Else it's activated.

◆ Transform()

Dtk_ErrorStatus Dtk_Welding::Transform ( const Dtk_transfo inTransfo)
virtual

Applies a transformation matrix to the entity. //!

Parameters
inTransfoThe transformation matrix to apply.

Implements Dtk_Annotation.

◆ WeldingSymbolEnumToString()

static Dtk_string Dtk_Welding::WeldingSymbolEnumToString ( const WeldingSymbolEnum inEnum)
static

Field Documentation

◆ _Private

Dtk_Handle* Dtk_Welding::_Private
protected

◆ count_

unsigned long Dtk_Object::count_
protectedinherited