Dtk_DatumTarget Class Reference

This is the Datum Target. More...

Inheritance diagram for Dtk_DatumTarget:

Public Types
enum	DatumTargetMovableStatusEnum { NonMovable = 0, Movable = 1 }
enum	DatumTargetTypeEnum {   Unknown = 0, Point = 1, Linear = 2, Rectangular = 3,   Circular = 4, Annular = 5, Spherical = 6, Cylindrical = 7,   Arbitrary = 8, NumTypes }
enum	DatumTargetValueEnum {   DiameterValue = 0, InnerDiameterValue = 1, OuterDiameterValue = 2, WidthValue = 3,   HeightValue = 4, StartPointValue = 5, EndPointValue = 6, AreaValue = 7,   NumValues }

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...
Dtk_ErrorStatus	AddLeader (const Dtk_LeaderPtr &leader)
	Adds a leader to the Dtk_Annotation. More...
Dtk_CompositeText &	BottomText ()
	Retrieves the bottom text - get/set -. More...
const Dtk_CompositeText &	BottomText () const
	Retrieves the bottom text - read only -. More...
void	DisableFrame ()
	Disables the frame status. 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)
void	EnableFrame ()
	Enables the frame status. 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_CompositeText &	GetAdditionnalTexts () const
	Retrieves the additionnal texts of the Dtk_2dEntity. More...
Dtk_ErrorStatus	GetAnchorPoints (Dtk_pnt(&outTabPnts)[DTK_NB_ANCHOR_TYPES])
	Processes all the Dtk_DatumTarget anchor points. More...
Dtk_ErrorStatus	GetAnchorPoints (Dtk_pnt(&outTabPnts)[DTK_NB_ANCHOR_TYPES]) const
	Processes all the Dtk_DatumTarget anchor points. More...
Dtk_DatumTarget::DatumTargetMovableStatusEnum	GetDatumTargetMovableStatus () const
	Gets the Movable status of the Dtk_DatumTarget. More...
Dtk_tab< Dtk_CurvePtr > &	GetDatumTargetMovableStatusRelatedGeom () const
	Gets the geometry related to the Movable status of the Dtk_DatumTarget. More...
Dtk_DatumTarget::DatumTargetTypeEnum	GetDatumTargetType () const
	Gets the type of the Dtk_DatumTarget. More...
const Dtk_Frame &	GetFrame () const
	Retrieves the frame of the Datum Target. More...
Dtk_tab< Dtk_EntityPtr >	GetGeometries () const
	Retrieves the Dtk_DatumTarget geometries - frame -. More...
const Dtk_ID &	GetID () const
	Get Internal UniqueID. More...
Dtk_LeaderPtr	GetLeader (const Dtk_Size_t &inPos) const
	Gets the i'th leader. More...
virtual Dtk_pnt	GetLocation () const
	Get the annoation location point. More...
const Dtk_anchor_type &	GetLocationAnchorType () const
	Gets the location anchor type - read only -. More...
Dtk_Size_t	GetNumLeaders () const
	Retrieves the number of leaders. More...
Dtk_Double64	GetOffset () const
	Gets the annotation offset - read only -. More...
const Dtk_LeaderPtr &	GetOptionnalBottomTextLeader () const
	Retrieves optionnal Leader of the Bottom Text. More...
const Dtk_LeaderPtr &	GetOptionnalTopTextLeader () const
	Retrieves optionnal Leader of the Top Text. More...
Dtk_ErrorStatus	GetParameterValue (const DatumTargetValueEnum &inValueEnum, Dtk_Val &outValue)
	Gets the value associated to DatumTargetValueEnum . 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_dir	GetXAxis () const
	Get the X Axis - read only -. More...
Dtk_dir	GetYAxis () const
	Get the Y Axis - read only -. More...
const Dtk_bool &	HasFrame () const
	Retrieves the frame status - read only -. More...
Dtk_InfoPtr &	info ()
Dtk_DatumTarget &	operator= (const Dtk_DatumTarget &in)
	Copy assignment operator. More...
Dtk_DatumTarget &	operator= (Dtk_DatumTarget &&in) DTK_NOEXCEPT
	Move assignment operator. More...
virtual void	PrepareTransfo ()
Dtk_Oriented2dBBox	ProcessBoundingBox () const
Dtk_pnt	ProcessCenterPoint () const
	Retrieves the center point - read only -. More...
Dtk_Double64	ProcessRadius () const
	Processes the Dtk_DatumTarget radius. More...
Dtk_ErrorStatus	Reverse ()
	Reverses the text The text anchor type is replaced by the opposed one and the text orientation is reversed. More...
Dtk_ErrorStatus	SetAnchorPoint (const Dtk_pnt &inNewLocation, const Dtk_anchor_type &inLocationAnchorType)
	Sets the Dtk_DatumTarget anchor point. More...
	SetAsDeprecated ("Undefined", "Use Dtk_TextStyle::Justification()") Dtk_justication_type GetJustification() const
	Get the justification type - read only -. More...
void	SetDatumTargetMovable (const DatumTargetMovableStatusEnum inMovableStatus, Dtk_tab< Dtk_CurvePtr > inMovableGeom)
	Sets the Movable status of the Dtk_DatumTarget. More...
void	SetDatumTargetType (const DatumTargetTypeEnum inType)
	Sets the type of the Dtk_DatumTarget. More...
void	SetFrame (Dtk_Frame inFrame)
	Sets the frame of the Datum Target. More...
Dtk_ErrorStatus	SetLocation (const Dtk_pnt &inLocation)
	Sets the location point of the Dtk_DatumTarget. 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_DatumTarget. More...
void	SetOptionnalBottomTextLeader (const Dtk_LeaderPtr &inLeader)
	Sets the optionnal Leader of the Bottom Text. More...
void	SetOptionnalTopTextLeader (const Dtk_LeaderPtr &inLeader)
	Sets the optionnal Leader of the Top Text. More...
Dtk_ErrorStatus	SetParameterValue (const DatumTargetValueEnum &inValueEnum, Dtk_Val inValue)
	Sets the value associated to DatumTargetValueEnum . More...
Dtk_ErrorStatus	SetRotationAngle (const Dtk_Double64 &inRotationAngle)
	Sets the annotation angle using the annotation base. More...
Dtk_ErrorStatus	SwapTexts ()
	Swaps the Dtk_DatumTarget texts. More...
Dtk_CompositeText &	TopText ()
	Retrieves the top text - get/set -. More...
const Dtk_CompositeText &	TopText () const
	Retrieves the top text - read only -. More...
Dtk_ErrorStatus	Transform (const Dtk_transfo &inTransfo)
	Applies a transformation matrix to the entity. //! More...
void	Translate (const Dtk_dir &inTranslationDir)
	Translates the Dtk_ReferenceBlock - internal use only -. More...

Static Public Member Functions
static Dtk_DatumTargetPtr	Create ()
	Calls default constructor to allocate a new object. More...
static Dtk_DatumTargetPtr	Create (const Dtk_DatumTarget &in)
	Calls copy constructor to allocate a new object. More...
static Dtk_DatumTargetPtr	Create (Dtk_CompositeText inTopText, Dtk_CompositeText inBottomText, const Dtk_pnt &inLocationPnt, const Dtk_InfoPtr &inInfos, Dtk_tab< Dtk_LeaderPtr > inLeadersArray=Dtk_tab< Dtk_LeaderPtr >(), const Dtk_Double64 &inAngle=0.0, const Dtk_Double64 &inOffSet=0.0, const Dtk_bool &inHasFrame=DTK_TRUE, const Dtk_anchor_type &inAnchorType=DTK_ANCHOR_BOTTOM_LEFT, const Dtk_justication_type &inJustificationType=DTK_JUSTIFY_LEFT)
	Calls full featured constructor to allocate a new object. More...
static Dtk_DatumTargetPtr	Create (Dtk_DatumTarget &&in)
	Calls move constructor to allocate a new object. More...
static Dtk_string	DatumTargetMovableStatusEnumToString (const DatumTargetMovableStatusEnum &inEnum)
static Dtk_string	DatumTargetTypeEnumToString (const DatumTargetTypeEnum &inEnum)
static Dtk_string	DatumTargetValueEnumToString (const DatumTargetValueEnum &inEnum)
static Dtk_DatumTarget *	DtkDynamicCast (Dtk_Object *s)
	Performs a dynamic cast - doesn't need RTTI -. More...

Protected Types
enum	{ _typeID = DTK_TYPE_2D_ENTITY }
enum	{ _typeID = DTK_TYPE_ENTITY }
enum	{ _typeID = DTK_TYPE_ANNOTATION }
enum	{ _typeID = DTK_TYPE_DATUM_TARGET }

Protected Member Functions
void	_Copy (const Dtk_2dEntity &s)
void	_copy (const Dtk_Entity &s)
void	_init ()
void	_reset ()
virtual Dtk_Object *	Clone ()
	Dtk_DatumTarget ()
	Dtk_DatumTarget (const Dtk_DatumTarget &inToBeCopied)
	Dtk_DatumTarget (Dtk_CompositeText inTopText, Dtk_CompositeText inBottomText, const Dtk_pnt &inLocationPnt, const Dtk_InfoPtr &inInfos, Dtk_tab< Dtk_LeaderPtr > inLeadersArray=Dtk_tab< Dtk_LeaderPtr >(), const Dtk_Double64 &inAngle=0.0, const Dtk_Double64 &inOffSet=0.0, const Dtk_bool &inHasFrame=DTK_TRUE, const Dtk_anchor_type &inAnchorType=DTK_ANCHOR_BOTTOM_LEFT, const Dtk_justication_type &inJustificationType=DTK_JUSTIFY_LEFT)
	Dtk_DatumTarget (Dtk_DatumTarget &&inToBeMoved) DTK_NOEXCEPT
	~Dtk_DatumTarget ()
	Destructor. More...

Protected Attributes
Dtk_Handle *	_Private
unsigned long	count_

Detailed Description

This is the Datum Target.

See also

Use Dtk_DatumTargetPtr class to handle it.

Member Enumeration Documentation

anonymous enum

anonymous enum

protectedinherited

Enumerator
_typeID

          {
          _typeID = DTK_TYPE_2D_ENTITY
     };

anonymous enum

anonymous enum

protectedinherited

Enumerator
_typeID

{ _typeID = DTK_TYPE_ENTITY };

anonymous enum

anonymous enum

protectedinherited

Enumerator
_typeID

          {
          _typeID = DTK_TYPE_ANNOTATION
     };

anonymous enum

anonymous enum

protected

Enumerator
_typeID

     {
          _typeID = DTK_TYPE_DATUM_TARGET
     };

DatumTargetMovableStatusEnum

enum Dtk_DatumTarget::DatumTargetMovableStatusEnum

Enumerator
NonMovable
Movable

     {
          NonMovable = 0,
          Movable = 1
     };

DatumTargetTypeEnum

enum Dtk_DatumTarget::DatumTargetTypeEnum

Enumerator
Unknown
Point
Linear
Rectangular
Circular
Annular
Spherical
Cylindrical
Arbitrary
NumTypes

    {
        Unknown     = 0,
        Point       = 1,
        Linear      = 2,
        Rectangular = 3,
        Circular    = 4,
        Annular     = 5,
        Spherical   = 6,
        Cylindrical = 7,
        Arbitrary   = 8,
 
        NumTypes
 
    };

DatumTargetValueEnum

enum Dtk_DatumTarget::DatumTargetValueEnum

Enumerator
DiameterValue
InnerDiameterValue
OuterDiameterValue
WidthValue
HeightValue
StartPointValue
EndPointValue
AreaValue
NumValues

     {
          DiameterValue      = 0,
          InnerDiameterValue = 1,
          OuterDiameterValue = 2,
          WidthValue         = 3,
          HeightValue        = 4,
          StartPointValue    = 5,
          EndPointValue      = 6,
          AreaValue          = 7,
          NumValues
     };

Constructor & Destructor Documentation

Dtk_DatumTarget() [1/4]

Dtk_DatumTarget::Dtk_DatumTarget ( )

protected

See also

Create()

Dtk_DatumTarget() [2/4]

Dtk_DatumTarget::Dtk_DatumTarget ( const Dtk_DatumTarget &  inToBeCopied )

protected

See also

Create(const Dtk_DatumTarget &)

Dtk_DatumTarget() [3/4]

Dtk_DatumTarget::Dtk_DatumTarget ( Dtk_DatumTarget &&  inToBeMoved )

protected

See also

Create( Dtk_DatumTarget &&)

Dtk_DatumTarget() [4/4]

Dtk_DatumTarget::Dtk_DatumTarget ( Dtk_CompositeText  inTopText, Dtk_CompositeText  inBottomText, const Dtk_pnt &  inLocationPnt, const Dtk_InfoPtr &  inInfos, Dtk_tab< Dtk_LeaderPtr >  inLeadersArray = Dtk_tab< Dtk_LeaderPtr >(), const Dtk_Double64 &  inAngle = 0.0, const Dtk_Double64 &  inOffSet = 0.0, const Dtk_bool &  inHasFrame = DTK_TRUE, const Dtk_anchor_type &  inAnchorType = DTK_ANCHOR_BOTTOM_LEFT, const Dtk_justication_type &  inJustificationType = DTK_JUSTIFY_LEFT  )

protected

See also

Create(const Dtk_CompositeText&, const Dtk_CompositeText&, const Dtk_pnt &, const Dtk_InfoPtr &,const Dtk_tab<Dtk_LeaderPtr> &,const Dtk_Double64 &,const Dtk_Double64 &,const Dtk_bool&, const Dtk_anchor_type &,const Dtk_justication_type &)

~Dtk_DatumTarget()

Dtk_DatumTarget::~Dtk_DatumTarget ( )

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()

virtual Dtk_ErrorStatus Dtk_Entity::_Store ( void *  )

virtualinherited

Reimplemented in Dtk_Shell, Dtk_Body, Dtk_Lump, Dtk_Volume, Dtk_Face, Dtk_Loop, Dtk_Coedge, Dtk_Edge, Dtk_Vertex, Dtk_TransformedSurface, Dtk_FilletSurface, Dtk_OffsetSurface, Dtk_SphericalSurface, Dtk_ToroidalSurface, Dtk_ConicalSurface, Dtk_CylindricalSurface, Dtk_RuledSurface, Dtk_LinearExtrusionSurface, Dtk_StandardRevolutionSurface, Dtk_RevolutionSurface, Dtk_PlaneSurface, Dtk_NurbsSurface, Dtk_Surface, Dtk_Hyperbola, Dtk_Parabola, Dtk_Ellipse, Dtk_Conic, Dtk_Line, Dtk_Polyline, Dtk_NurbsCurve, Dtk_Curve, and Dtk_Point.

AddAdditionnalGeometries()

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

inherited

Adds some additionnal geometries to the Dtk_2dEntity.

Parameters

inAdditionnalGeometries

The geometries to be added

AddAdditionnalGeometry()

void Dtk_2dEntity::AddAdditionnalGeometry ( const Dtk_EntityPtr &  inAdditionnalGeometry )

inherited

Adds an additionnal geometry to the Dtk_2dEntity.

Parameters

inAdditionnalGeometry

The geometry to be added

AddAdditionnalTexts()

void Dtk_2dEntity::AddAdditionnalTexts ( Dtk_CompositeText  inAddtionnalTexts )

inherited

Adds some additionnal texts to the Dtk_2dEntity.

Parameters

inAddtionnalTexts

The texts to be added

AddLeader()

Dtk_ErrorStatus Dtk_Annotation::AddLeader ( const Dtk_LeaderPtr &  leader )

inherited

Adds a leader to the Dtk_Annotation.

Parameters

leader

The leader to be added

Returns

dtkNoError is OK

Remarks

If Added leader is NULL, so no leader is added.

BottomText() [1/2]

Dtk_CompositeText& Dtk_DatumTarget::BottomText

(

)

Retrieves the bottom text - get/set -.

Returns

The bottom text

See also

BottomText() const

BottomText() [2/2]

const Dtk_CompositeText& Dtk_DatumTarget::BottomText

(

)

const

Retrieves the bottom text - read only -.

Returns

The bottom text

See also

BottomText()

Clone()

virtual Dtk_Object* Dtk_DatumTarget::Clone ( )

protectedvirtual

Implements Dtk_Annotation.

{ return new Dtk_DatumTarget(*this); }

Create() [1/4]

static Dtk_DatumTargetPtr Dtk_DatumTarget::Create ( )

static

Calls default constructor to allocate a new object.

Create() [2/4]

static Dtk_DatumTargetPtr Dtk_DatumTarget::Create ( const Dtk_DatumTarget &  in )

static

Calls copy constructor to allocate a new object.

Parameters

in	Object to copy from.

Create() [3/4]

static Dtk_DatumTargetPtr Dtk_DatumTarget::Create ( Dtk_CompositeText  inTopText, Dtk_CompositeText  inBottomText, const Dtk_pnt &  inLocationPnt, const Dtk_InfoPtr &  inInfos, Dtk_tab< Dtk_LeaderPtr >  inLeadersArray = Dtk_tab< Dtk_LeaderPtr >(), const Dtk_Double64 &  inAngle = 0.0, const Dtk_Double64 &  inOffSet = 0.0, const Dtk_bool &  inHasFrame = DTK_TRUE, const Dtk_anchor_type &  inAnchorType = DTK_ANCHOR_BOTTOM_LEFT, const Dtk_justication_type &  inJustificationType = DTK_JUSTIFY_LEFT  )

static

Calls full featured constructor to allocate a new object.

Parameters

inTopText	Top text
inBottomText	Bottom text
inLocationPnt	The Dtk_DatumTarget location
inInfos	Dtk_DatumTarget infos
inLeadersArray	Leaders array
inAngle	Angle
inOffSet	Offset
inHasFrame	DTK_TRUE if the Dtk_DatumTarget has frame
inAnchorType	Dtk_DatumTarget anchor type
inJustificationType	Justification type

Returns

The created Dtk_DatumTargetPtr

Create() [4/4]

static Dtk_DatumTargetPtr Dtk_DatumTarget::Create ( Dtk_DatumTarget &&  in )

static

Calls move constructor to allocate a new object.

Parameters

in	Object to move from.

DatumTargetMovableStatusEnumToString()

static Dtk_string Dtk_DatumTarget::DatumTargetMovableStatusEnumToString ( const DatumTargetMovableStatusEnum &  inEnum )

static

     {
          switch( inEnum )
          {
               default:
               case NonMovable:    return L"NonMovable";
               case Movable:       return L"Movable";
          }
     }

DatumTargetTypeEnumToString()

static Dtk_string Dtk_DatumTarget::DatumTargetTypeEnumToString ( const DatumTargetTypeEnum &  inEnum )

static

    {
        switch( inEnum )
        {
        default:
        case Unknown:       return L"Unknown";
        case Point:         return L"Point";
        case Linear:        return L"Linear";
        case Rectangular:   return L"Rectangular";
        case Circular:      return L"Circular";
        case Annular:       return L"Annular";
        case Spherical:     return L"Spherical";
        case Cylindrical:   return L"Cylindrical";
        case Arbitrary:     return L"Arbitrary";
        }
    }

DatumTargetValueEnumToString()

static Dtk_string Dtk_DatumTarget::DatumTargetValueEnumToString ( const DatumTargetValueEnum &  inEnum )

static

     {
          switch (inEnum)
          {
          default:
          case DiameterValue:       return L"DiameterValue";
          case InnerDiameterValue:  return L"InnerDiameterValue";
          case OuterDiameterValue:  return L"OuterDiameterValue";
          case WidthValue:          return L"WidthValue";
          case HeightValue:         return L"HeightValue";
          case StartPointValue:     return L"StartPointValue";
          case EndPointValue:       return L"EndPointValue";
          case AreaValue:           return L"AreaValue";
          }
     }

DisableFrame()

void Dtk_DatumTarget::DisableFrame

(

)

Disables the frame status.

See also

HasFrame() const

DisableFrame()

DtkDynamicCast()

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

static

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

DtkDynamicType() [1/2]

Dtk_Int32 Dtk_DatumTarget::DtkDynamicType

(

const Dtk_Int32 &

inId

)

Retrieves the dynamic entity type.

DtkDynamicType() [2/2]

int Dtk_Entity::DtkDynamicType ( const int &  inId )

virtualinherited

Implements Dtk_Object.

Reimplemented in Dtk_Shell, Dtk_Body, Dtk_Lump, Dtk_Volume, Dtk_Face, Dtk_Loop, Dtk_Coedge, Dtk_Edge, Dtk_Vertex, Dtk_TopologicalEntity, Dtk_MeshSurface, Dtk_TransformedSurface, Dtk_FilletSurface, Dtk_OffsetSurface, Dtk_SphericalSurface, Dtk_ToroidalSurface, Dtk_ConicalSurface, Dtk_CylindricalSurface, Dtk_RuledSurface, Dtk_LinearExtrusionSurface, Dtk_StandardRevolutionSurface, Dtk_RevolutionSurface, Dtk_PlaneSurface, Dtk_NurbsSurface, Dtk_Surface, Dtk_Hyperbola, Dtk_Parabola, Dtk_Ellipse, Dtk_Conic, Dtk_Line, Dtk_Polyline, Dtk_NurbsCurve, Dtk_Curve, Dtk_Point, Dtk_Constraint, Dtk_ConstraintReference, and Dtk_AxisSystem.

dump()

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

virtualinherited

EnableFrame()

void Dtk_DatumTarget::EnableFrame

(

)

Enables the frame status.

See also

HasFrame() const

DisableFrame()

get_info()

Dtk_InfoPtr Dtk_Entity::get_info ( ) const

inherited

get_type_detk()

type_detk Dtk_DatumTarget::get_type_detk ( ) const

virtual

Returns

The type of the entity type - DTK_TYPE_DATUM_TARGET -

Implements Dtk_Annotation.

     {
          return DTK_TYPE_DATUM_TARGET;
     }

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_DatumTarget::GetAnchorPoints

(

Dtk_pnt(&)

outTabPnts[DTK_NB_ANCHOR_TYPES]

)

Processes all the Dtk_DatumTarget anchor points.

Parameters

outTabPnts

The resulting anchor point array.

Returns

dtkNoError if OK

GetAnchorPoints() [2/2]

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

virtual

Processes all the Dtk_DatumTarget anchor points.

Parameters

outTabPnts

The resulting anchor point array.

Returns

dtkNoError if OK

Implements Dtk_Annotation.

GetDatumTargetMovableStatus()

Dtk_DatumTarget::DatumTargetMovableStatusEnum Dtk_DatumTarget::GetDatumTargetMovableStatus

(

)

const

Gets the Movable status of the Dtk_DatumTarget.

Returns

The Dtk_DatumTarget Movable status

See also

SetDatumTargetMovable() const

GetDatumTargetMovableStatusRelatedGeom()

Dtk_tab<Dtk_CurvePtr>& Dtk_DatumTarget::GetDatumTargetMovableStatusRelatedGeom

(

)

const

Gets the geometry related to the Movable status of the Dtk_DatumTarget.

Returns

The tab of Dtk_CurvePtr composing the geometry related to the Movable status

See also

SetDatumTargetMovable() const

GetDatumTargetType()

Dtk_DatumTarget::DatumTargetTypeEnum Dtk_DatumTarget::GetDatumTargetType

(

)

const

Gets the type of the Dtk_DatumTarget.

Returns

The Dtk_DatumTarget type

See also

GetDatumTargetType() const

GetFrame()

const Dtk_Frame& Dtk_DatumTarget::GetFrame

(

)

const

Retrieves the frame of the Datum Target.

Returns

The Dtk_Frame

See also

SetFrame()

GetGeometries()

Dtk_tab< Dtk_EntityPtr > Dtk_DatumTarget::GetGeometries

(

)

const

Retrieves the Dtk_DatumTarget geometries - frame -.

Returns

All the geometries asked.

GetID()

const Dtk_ID& Dtk_Entity::GetID ( ) const

inherited

Get Internal UniqueID.

Returns

InternalID

GetLeader()

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

inherited

Gets the i'th leader.

Parameters

inPos

The leader position - 0 indexed -

Returns

The inPos'th leader

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

GetOffset()

Dtk_Double64 Dtk_Annotation::GetOffset ( ) const

inherited

Gets the annotation offset - read only -.

Returns

The annotation offset.

Warning

For internal use only

GetOptionnalBottomTextLeader()

const Dtk_LeaderPtr& Dtk_DatumTarget::GetOptionnalBottomTextLeader

(

)

const

Retrieves optionnal Leader of the Bottom Text.

Returns

The Dtk_LeaderPtr

See also

SetOptionnalBottomTextLeader()

GetOptionnalTopTextLeader()

const Dtk_LeaderPtr& Dtk_DatumTarget::GetOptionnalTopTextLeader

(

)

const

Retrieves optionnal Leader of the Top Text.

Returns

The Dtk_LeaderPtr

See also

SetOptionnalTopTextLeader()

GetParameterValue()

Dtk_ErrorStatus Dtk_DatumTarget::GetParameterValue	(	const DatumTargetValueEnum &	inValueEnum,
		Dtk_Val &	outValue
	)

Gets the value associated to DatumTargetValueEnum .

Parameters

outValue

Get the value associated to inValueEnum

Returns

dtkNoError if OK

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

inXAxis	The reference X Axis - default value = (1,0,0) -
inYAxis	The reference Y Axis - default value = (0,1,0) -

Returns

The rotation angle.

GetSize()

virtual Dtk_Size_t Dtk_Entity::GetSize ( ) const

virtualinherited

Reimplemented from Dtk_Object.

Reimplemented in Dtk_Shell, Dtk_Body, Dtk_Lump, Dtk_Volume, Dtk_Face, Dtk_Loop, Dtk_Coedge, Dtk_Edge, Dtk_Vertex, Dtk_mesh, Dtk_TransformedSurface, Dtk_FilletSurface, Dtk_OffsetSurface, Dtk_SphericalSurface, Dtk_ToroidalSurface, Dtk_ConicalSurface, Dtk_CylindricalSurface, Dtk_RuledSurface, Dtk_LinearExtrusionSurface, Dtk_StandardRevolutionSurface, Dtk_RevolutionSurface, Dtk_PlaneSurface, Dtk_NurbsSurface, Dtk_Surface, Dtk_Hyperbola, Dtk_Parabola, Dtk_Ellipse, Dtk_Conic, Dtk_Line, Dtk_Polyline, Dtk_NurbsCurve, Dtk_Curve, and Dtk_Point.

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.

HasFrame()

const Dtk_bool& Dtk_DatumTarget::HasFrame

(

)

const

Retrieves the frame status - read only -.

Returns

The text frame status

See also

EnableFrame()

DisableFrame()

info()

Dtk_InfoPtr& Dtk_Entity::info ( )

inherited

operator=() [1/2]

Dtk_DatumTarget& Dtk_DatumTarget::operator=

(

const Dtk_DatumTarget &

in

)

Copy assignment operator.

Parameters

in	Object to copy from.

operator=() [2/2]

Dtk_DatumTarget& Dtk_DatumTarget::operator=

(

Dtk_DatumTarget &&

in

)

Move assignment operator.

Parameters

in	Object to move from.

PrepareTransfo()

virtual void Dtk_Entity::PrepareTransfo ( )

virtualinherited

Reimplemented in Dtk_OffsetSurface.

ProcessBoundingBox()

Dtk_Oriented2dBBox Dtk_DatumTarget::ProcessBoundingBox

(

)

const

ProcessCenterPoint()

Dtk_pnt Dtk_DatumTarget::ProcessCenterPoint

(

)

const

Retrieves the center point - read only -.

Returns

The center point

See also

CenterPoint()

ProcessRadius()

Dtk_Double64 Dtk_DatumTarget::ProcessRadius

(

)

const

Processes the Dtk_DatumTarget radius.

Returns

the processed radius.

Reverse()

Dtk_ErrorStatus Dtk_DatumTarget::Reverse ( )

virtual

Reverses the text The text anchor type is replaced by the opposed one and the text orientation is reversed.

Returns

dtkNoError if OK

Reimplemented from Dtk_Annotation.

SetAnchorPoint()

Dtk_ErrorStatus Dtk_DatumTarget::SetAnchorPoint ( const Dtk_pnt &  inNewLocation, const Dtk_anchor_type &  inLocationAnchorType  )

virtual

Sets the Dtk_DatumTarget anchor point.

Parameters

inNewLocation	The new location point.
inLocationAnchorType	The anchor type related to the new location.

Returns

dtkNoError if OK

Implements Dtk_Annotation.

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

SetDatumTargetMovable()

void Dtk_DatumTarget::SetDatumTargetMovable	(	const DatumTargetMovableStatusEnum	inMovableStatus,
		Dtk_tab< Dtk_CurvePtr >	inMovableGeom
	)

Sets the Movable status of the Dtk_DatumTarget.

Parameters

inMovableStatus	The Dtk_DatumTarget Movable status
inMovableGeom	The geometry related to the Movable status

See also

GetDatumTargetMovableStatus() const

GetDatumTargetMovableStatusRelatedGeom() const

SetDatumTargetType()

void Dtk_DatumTarget::SetDatumTargetType

(

const DatumTargetTypeEnum

inType

)

Sets the type of the Dtk_DatumTarget.

Parameters

inType

The Dtk_DatumTarget type

See also

GetDatumTargetType() const

SetFrame()

void Dtk_DatumTarget::SetFrame

(

Dtk_Frame

inFrame

)

Sets the frame of the Datum Target.

Parameters

inFrame

The Dtk_Frame

See also

GetFrame() const

SetLocation() [1/2]

Dtk_ErrorStatus Dtk_DatumTarget::SetLocation ( const Dtk_pnt &  inLocation )

virtual

Sets the location point of the Dtk_DatumTarget.

The location point is related to the anchor type

Parameters

inLocation

the 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

location	the location point
inAnchorType	The anchor type related to the new location.

Returns

dtkNoError if OK

SetOffset()

Dtk_ErrorStatus Dtk_DatumTarget::SetOffset ( const Dtk_Double64 &  inOffset )

virtual

Sets the offset of the Dtk_DatumTarget.

The Offset is used to process bounding frames.

Parameters

inOffset

The offset

Returns

dtkNoError if OK

Warning

For internal use only

Implements Dtk_Annotation.

SetOptionnalBottomTextLeader()

void Dtk_DatumTarget::SetOptionnalBottomTextLeader

(

const Dtk_LeaderPtr &

inLeader

)

Sets the optionnal Leader of the Bottom Text.

Parameters

inLeader

The Dtk_LeaderPtr

See also

GetOptionnalBottomTextLeader() const

SetOptionnalTopTextLeader()

void Dtk_DatumTarget::SetOptionnalTopTextLeader

(

const Dtk_LeaderPtr &

inLeader

)

Sets the optionnal Leader of the Top Text.

Parameters

inLeader

The Dtk_LeaderPtr

See also

GetOptionnalTopTextLeader() const

SetParameterValue()

Dtk_ErrorStatus Dtk_DatumTarget::SetParameterValue	(	const DatumTargetValueEnum &	inValueEnum,
		Dtk_Val	inValue
	)

Sets the value associated to DatumTargetValueEnum .

Parameters

inValue

Set the inValue associated to the inValueEnum

Returns

dtkNoError if OK

SetRotationAngle()

Dtk_ErrorStatus Dtk_DatumTarget::SetRotationAngle ( const Dtk_Double64 &  inRotationAngle )

virtual

Sets the annotation angle using the annotation base.

Parameters

inRotationAngle

The rotation angle to be set

Returns

dtkNoError if OK

Reimplemented from Dtk_Annotation.

SwapTexts()

Dtk_ErrorStatus Dtk_DatumTarget::SwapTexts

(

)

Swaps the Dtk_DatumTarget texts.

Returns

dtkNoError if OK

TopText() [1/2]

Dtk_CompositeText& Dtk_DatumTarget::TopText

(

)

Retrieves the top text - get/set -.

Returns

The top text

See also

TopText() const

TopText() [2/2]

const Dtk_CompositeText& Dtk_DatumTarget::TopText

(

)

const

Retrieves the top text - read only -.

Returns

The top text

See also

TopText()

Transform()

Dtk_ErrorStatus Dtk_DatumTarget::Transform ( const Dtk_transfo &  inTransfo )

virtual

Applies a transformation matrix to the entity. //!

Parameters

inTransfo

The transformation matrix to apply.

Implements Dtk_Annotation.

Translate()

void Dtk_DatumTarget::Translate

(

const Dtk_dir &

inTranslationDir

)

Translates the Dtk_ReferenceBlock - internal use only -.

Parameters

inTranslationDir

the translation vector.

Field Documentation

_Private

Dtk_Handle* Dtk_DatumTarget::_Private

protected

count_

unsigned long Dtk_Object::count_

protectedinherited