Dtk_Roughness Class Reference

This is the Roughness class. More...

Inheritance diagram for Dtk_Roughness:

Public Types
enum	ApplyToEnum { ApplyToSpecifiedSurface = 0, ApplyToSurroundingSurfaces, ApplyToBasicSurface, ApplyToAllSurfaces }
enum	ObtentionTypeEnum { ObtentionTypeNotDefined = 0, ObtentionTypeMachiningMandatory, ObtentionTypeMachiningForbidden }
enum	RoughModeEnum {   ModeNone = 0, ModeMultiDirectional, ModeCircular, ModeRadial,   ModeParticular, ModeWithAngles, ModeParallel, ModePerpendicular }

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	AddAssociatedGeometries (Dtk_tab< Dtk_EntityPtr > inAssociatedGeometries)
	Add Geometries associated to whole Dtk_Roughness. More...
Dtk_ErrorStatus	AddLeader (const Dtk_LeaderPtr &leader)
	Adds a leader to the Dtk_Annotation. 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_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_Annotation anchor points. More...
Dtk_ErrorStatus	GetAnchorPoints (Dtk_pnt(&outTabPnts)[DTK_NB_ANCHOR_TYPES]) const
	Processes all the Dtk_Annotation anchor points. More...
Dtk_Text	GetBottomLeftText () const
	Gets the bottom-left text - read only -. More...
Dtk_Text	GetBottomRightText () const
	Gets the bottom-right text - read only -. More...
Dtk_Text	GetCutOff () const
	Gets the CutOff text - read only -. More...
Dtk_tab< Dtk_EntityPtr >	GetGeometries () const
	Retrieves the Dtk_Roughness geometries. More...
const Dtk_ID &	GetID () const
	Get Internal UniqueID. More...
Dtk_Int32	GetInvertText () const
	Gets text is invert or not. 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_Text	GetMiddleLeftText () const
	Gets the middle-left text - read only -. More...
Dtk_Text	GetMiddleRightText () const
	Gets the middle-right text - 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...
Dtk_Text	GetOtherRequirement () const
	Gets the OtherRequirement text - read only -. More...
Dtk_Oriented2dBBox	GetOuterBoundingBox (const Dtk_bool inIncludeSymbolGeometry) const
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...
RoughModeEnum	GetRoughMode () const
	Gets the rough mode - read only -. More...
ApplyToEnum	GetRoughnessApplyTo () const
	Gets the apply-to type - read only -. More...
ObtentionTypeEnum	GetRoughnessType () const
	Gets the obtention type - read only -. More...
virtual Dtk_Size_t	GetSize () const
void	GetSymbolColor (Dtk_Int32 &outColorId) const
	get the color of the Symbol More...
Dtk_Text	GetTopLeftText () const
	Gets the top-left text - read only -. More...
Dtk_Text	GetTopRightText () const
	Gets the top-right text - read only -. More...
Dtk_dir	GetXAxis () const
	Get the X Axis - read only -. More...
Dtk_dir	GetYAxis () const
	Get the Y Axis - read only -. More...
Dtk_InfoPtr &	info ()
Dtk_Roughness &	operator= (const Dtk_Roughness &in)
	Copy assignment operator. More...
virtual void	PrepareTransfo ()
void	ProcessSymbolInfos (Dtk_tab< Dtk_pnt > &outPnts, Dtk_Double64 &outCircleRadius) const
	Process the Roughness Symbol Informations as shown in the picture below. More...
virtual Dtk_ErrorStatus	Reverse ()
	Reverses the Dtk_Annotation. More...
Dtk_Text	rough_mode_to_Dtk_Text () const
	Converts the rough mode into a Dtk_Text - used to Dtk_Symbol conversion -. More...
Dtk_ErrorStatus	SetAnchorPoint (const Dtk_pnt &inNewLocation, const Dtk_anchor_type &inLocationAnchorType)
	Sets the Dtk_Roughness anchor point. More...
	SetAsDeprecated ("Undefined", "Use Dtk_TextStyle::Justification()") Dtk_justication_type GetJustification() const
	Get the justification type - read only -. More...
Dtk_ErrorStatus	SetBottomLeftText (Dtk_Text inText)
	Sets the bottom-left text. More...
Dtk_ErrorStatus	SetBottomRightText (Dtk_Text inText)
	Sets the bottom-right text. More...
Dtk_ErrorStatus	SetCutOff (Dtk_Text inText)
	Sets the CutOff text. More...
void	SetInvertText (Dtk_Int32 inValue=DTK_FALSE)
	Sets text are invert. 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	SetMiddleLeftText (Dtk_Text inText)
	Sets the middle-left text. More...
Dtk_ErrorStatus	SetMiddleRightText (Dtk_Text inText)
	Sets the middle-right text. More...
Dtk_ErrorStatus	SetOffset (const Dtk_Double64 &inOffset)
	Sets the offset of the Dtk_Annotation. More...
Dtk_ErrorStatus	SetOtherRequirement (Dtk_Text inText)
	Sets the OtherRequirement text. More...
Dtk_ErrorStatus	SetRotationAngle (const Dtk_Double64 &angle)
	Sets the annotation angle using the annotation base. More...
Dtk_ErrorStatus	SetRoughMode (Dtk_Text inRoughModeText)
	Sets the rough mode. More...
Dtk_ErrorStatus	SetRoughnessApplyTo (const ApplyToEnum &inApplyTo)
	Sets the apply-to type. More...
Dtk_ErrorStatus	SetRoughnessType (const ObtentionTypeEnum &inObtentionType)
	Sets the obtention type. More...
void	SetSymbolColor (Dtk_Int32 inColorId) const
	set the color of the Symbol More...
Dtk_ErrorStatus	SetTopLeftText (Dtk_Text inText)
	Sets the top-left text. More...
Dtk_ErrorStatus	SetTopRightText (Dtk_Text inText)
	Sets the top-right text. 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_RoughnessPtr	Create ()
	Calls default constructor to allocate a new object. More...
static Dtk_RoughnessPtr	Create (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_anchor_type &inAnchorType=DTK_ANCHOR_BOTTOM_LEFT, const Dtk_justication_type &inJustificationType=DTK_JUSTIFY_LEFT)
	Full featured constructor. More...
static Dtk_RoughnessPtr	Create (const Dtk_pnt &inLocationPnt, Dtk_Text inTopLeftText=Dtk_Text(), Dtk_Text inMiddleLeftText=Dtk_Text(), Dtk_Text inBottomLeftText=Dtk_Text(), Dtk_Text inTopRightText=Dtk_Text(), Dtk_Text inMiddleRightText=Dtk_Text(), Dtk_Text inBottomRightText=Dtk_Text(), const ObtentionTypeEnum &inObtentionType=ObtentionTypeNotDefined, const ApplyToEnum &inApplyToType=ApplyToSpecifiedSurface, const Dtk_InfoPtr &inInfos=NULL, Dtk_tab< Dtk_LeaderPtr > inLeadersArray=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 &inJustificationType=DTK_JUSTIFY_LEFT)
	Full featured constructor. More...
static Dtk_RoughnessPtr	Create (const Dtk_Roughness &in)
	Calls copy constructor to allocate a new object. More...
static Dtk_RoughnessPtr	Create (Dtk_Roughness &&in)
	Calls move constructor to allocate a new object. More...
static Dtk_Roughness *	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_ROUGHNESS }

Protected Member Functions
void	_Copy (const Dtk_2dEntity &s)
void	_copy (const Dtk_Entity &s)
Dtk_pnt	_GetStartPoint () const
void	_init ()
Dtk_Double64	_ProcessSideLength ()
void	_reset ()
virtual Dtk_Object *	Clone ()
	Dtk_Roughness ()
	Dtk_Roughness (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_anchor_type &inAnchorType=DTK_ANCHOR_BOTTOM_LEFT, const Dtk_justication_type &inJustificationType=DTK_JUSTIFY_LEFT)
	Dtk_Roughness (const Dtk_pnt &inLocationPnt, Dtk_Text inTopLeftText=Dtk_Text(), Dtk_Text inMiddleLeftText=Dtk_Text(), Dtk_Text inBottomLeftText=Dtk_Text(), Dtk_Text inTopRightText=Dtk_Text(), Dtk_Text inMiddleRightText=Dtk_Text(), Dtk_Text inBottomRightText=Dtk_Text(), const ObtentionTypeEnum &inObtentionType=ObtentionTypeNotDefined, const ApplyToEnum &inApplyToType=ApplyToSpecifiedSurface, const Dtk_InfoPtr &inInfos=NULL, Dtk_tab< Dtk_LeaderPtr > inLeadersArray=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 &inJustificationType=DTK_JUSTIFY_LEFT)
	Dtk_Roughness (const Dtk_Roughness &s)
	Dtk_Roughness (Dtk_Roughness &&s) DTK_NOEXCEPT
	~Dtk_Roughness ()
	Destructor. More...

Protected Attributes
Dtk_Handle *	_Private
unsigned long	count_

Detailed Description

This is the Roughness class.

See also

Use Dtk_RoughnessPtr 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_ROUGHNESS
     };

ApplyToEnum

enum Dtk_Roughness::ApplyToEnum

Enumerator
ApplyToSpecifiedSurface
ApplyToSurroundingSurfaces
ApplyToBasicSurface
ApplyToAllSurfaces

                     {
          ApplyToSpecifiedSurface = 0,
          ApplyToSurroundingSurfaces,
          ApplyToBasicSurface,
          ApplyToAllSurfaces
     };

ObtentionTypeEnum

enum Dtk_Roughness::ObtentionTypeEnum

Enumerator
ObtentionTypeNotDefined
ObtentionTypeMachiningMandatory
ObtentionTypeMachiningForbidden

                           {
          ObtentionTypeNotDefined = 0,
          ObtentionTypeMachiningMandatory,
          ObtentionTypeMachiningForbidden
     };

RoughModeEnum

enum Dtk_Roughness::RoughModeEnum

Enumerator
ModeNone
ModeMultiDirectional
ModeCircular
ModeRadial
ModeParticular
ModeWithAngles
ModeParallel
ModePerpendicular

                       {
          ModeNone = 0,
          ModeMultiDirectional,
          ModeCircular,
          ModeRadial,
          ModeParticular,
          ModeWithAngles,
          ModeParallel,
          ModePerpendicular
     };

Constructor & Destructor Documentation

Dtk_Roughness() [1/5]

Dtk_Roughness::Dtk_Roughness ( )

protected

See also

Create()

Dtk_Roughness() [2/5]

Dtk_Roughness::Dtk_Roughness ( const Dtk_pnt &  inLocationPnt, Dtk_Text  inTopLeftText = Dtk_Text(), Dtk_Text  inMiddleLeftText = Dtk_Text(), Dtk_Text  inBottomLeftText = Dtk_Text(), Dtk_Text  inTopRightText = Dtk_Text(), Dtk_Text  inMiddleRightText = Dtk_Text(), Dtk_Text  inBottomRightText = Dtk_Text(), const ObtentionTypeEnum &  inObtentionType = ObtentionTypeNotDefined, const ApplyToEnum &  inApplyToType = ApplyToSpecifiedSurface, const Dtk_InfoPtr &  inInfos = NULL, Dtk_tab< Dtk_LeaderPtr >  inLeadersArray = 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 &  inJustificationType = DTK_JUSTIFY_LEFT  )

protected

See also

Create(const Dtk_pnt &, const Dtk_Text &, const Dtk_Text &, const Dtk_Text &, const Dtk_Text &, const Dtk_Text &, const Dtk_Text &, const ObtentionTypeEnum &, const ApplyToEnum &, const Dtk_InfoPtr &, const Dtk_tab<Dtk_LeaderPtr> &, const Dtk_Double64 &, const Dtk_Double64 &,const Dtk_anchor_type &,const Dtk_justication_type &)

Dtk_Roughness() [3/5]

Dtk_Roughness::Dtk_Roughness ( 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_anchor_type &  inAnchorType = DTK_ANCHOR_BOTTOM_LEFT, const Dtk_justication_type &  inJustificationType = 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_Roughness() [4/5]

Dtk_Roughness::Dtk_Roughness ( const Dtk_Roughness &  s )

protected

See also

Create(const Dtk_Roughness &)

Dtk_Roughness() [5/5]

Dtk_Roughness::Dtk_Roughness ( Dtk_Roughness &&  s )

protected

See also

Create( Dtk_Roughness &&)

~Dtk_Roughness()

Dtk_Roughness::~Dtk_Roughness ( )

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

_GetStartPoint()

Dtk_pnt Dtk_Roughness::_GetStartPoint ( ) const

protected

_init()

void Dtk_Entity::_init ( )

protectedinherited

_ProcessSideLength()

Dtk_Double64 Dtk_Roughness::_ProcessSideLength ( )

protected

_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

AddAssociatedGeometries()

void Dtk_Roughness::AddAssociatedGeometries

(

Dtk_tab< Dtk_EntityPtr >

inAssociatedGeometries

)

Add Geometries associated to whole Dtk_Roughness.

Remarks

Used to Dtk_Symbol convertion.

Parameters

inAssociatedGeometries

The Geometries associated to the Dtk_Roughness.

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.

Clone()

virtual Dtk_Object* Dtk_Roughness::Clone ( )

protectedvirtual

Implements Dtk_Annotation.

{ return new Dtk_Roughness(*this); }

Create() [1/5]

static Dtk_RoughnessPtr Dtk_Roughness::Create ( )

static

Calls default constructor to allocate a new object.

Create() [2/5]

static Dtk_RoughnessPtr Dtk_Roughness::Create ( 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_anchor_type &  inAnchorType = DTK_ANCHOR_BOTTOM_LEFT, const Dtk_justication_type &  inJustificationType = DTK_JUSTIFY_LEFT  )

static

Full featured constructor.

Parameters

inLocationPnt	Location point
inInfos	Roughness infos
inLeadersArray	Leaders array
inAngle	Angle
inOffSet	Offset
inAnchorType	Roughness anchor type
inJustificationType	Justification type

Returns

The created Dtk_RoughnessPtr

Create() [3/5]

static Dtk_RoughnessPtr Dtk_Roughness::Create ( const Dtk_pnt &  inLocationPnt, Dtk_Text  inTopLeftText = Dtk_Text(), Dtk_Text  inMiddleLeftText = Dtk_Text(), Dtk_Text  inBottomLeftText = Dtk_Text(), Dtk_Text  inTopRightText = Dtk_Text(), Dtk_Text  inMiddleRightText = Dtk_Text(), Dtk_Text  inBottomRightText = Dtk_Text(), const ObtentionTypeEnum &  inObtentionType = ObtentionTypeNotDefined, const ApplyToEnum &  inApplyToType = ApplyToSpecifiedSurface, const Dtk_InfoPtr &  inInfos = NULL, Dtk_tab< Dtk_LeaderPtr >  inLeadersArray = 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 &  inJustificationType = DTK_JUSTIFY_LEFT  )

static

Full featured constructor.

Parameters

inLocationPnt	Location point
inTopLeftText	Top left text
inMiddleLeftText	Middle left text
inBottomLeftText	Bottom left text
inTopRightText	Top right text
inMiddleRightText	Middle right text
inBottomRightText	Bottom right text
inObtentionType	Obtention type
inApplyToType	ApplyTo type
inInfos	Roughness infos
inLeadersArray	Leaders array
inAngle	Angle
inOffSet	Offset
inAnchorType	Roughness anchor type
inJustificationType	Justification type

Returns

The created Dtk_RoughnessPtr

Create() [4/5]

static Dtk_RoughnessPtr Dtk_Roughness::Create ( const Dtk_Roughness &  in )

static

Calls copy constructor to allocate a new object.

Parameters

in	Object to copy from.

Create() [5/5]

static Dtk_RoughnessPtr Dtk_Roughness::Create ( Dtk_Roughness &&  in )

static

Calls move constructor to allocate a new object.

Parameters

in	Object to move from.

DtkDynamicCast()

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

static

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

DtkDynamicType() [1/2]

Dtk_Int32 Dtk_Roughness::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

get_info()

Dtk_InfoPtr Dtk_Entity::get_info ( ) const

inherited

get_type_detk()

type_detk Dtk_Roughness::get_type_detk ( ) const

virtual

Returns

The type of the entity type - DTK_TYPE_ROUGHNESS -

Implements Dtk_Annotation.

{ return DTK_TYPE_ROUGHNESS; }

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

(

Dtk_pnt(&)

outTabPnts[DTK_NB_ANCHOR_TYPES]

)

Processes all the Dtk_Annotation anchor points.

Parameters

outTabPnts

The resulting anchor point array.

Returns

dtkNoError if OK

GetAnchorPoints() [2/2]

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

virtual

Processes all the Dtk_Annotation anchor points.

Parameters

outTabPnts

The resulting anchor point array.

Returns

dtkNoError if OK

Implements Dtk_Annotation.

GetBottomLeftText()

Dtk_Text Dtk_Roughness::GetBottomLeftText

(

)

const

Gets the bottom-left text - read only -.

Returns

The bottom-left text

See also

SetBottomLeftText

GetBottomRightText()

Dtk_Text Dtk_Roughness::GetBottomRightText

(

)

const

Gets the bottom-right text - read only -.

Returns

The bottom-right text

See also

SetBottomRightText

GetCutOff()

Dtk_Text Dtk_Roughness::GetCutOff

(

)

const

Gets the CutOff text - read only -.

Returns

The CutOff text

See also

SetCutOff

GetGeometries()

Dtk_tab< Dtk_EntityPtr > Dtk_Roughness::GetGeometries

(

)

const

Retrieves the Dtk_Roughness geometries.

Returns

All the associated geometries asked.

GetID()

const Dtk_ID& Dtk_Entity::GetID ( ) const

inherited

Get Internal UniqueID.

Returns

InternalID

GetInvertText()

Dtk_Int32 Dtk_Roughness::GetInvertText

(

)

const

Gets text is invert or not.

Returns

DTK_TRUE if all text are invert , DTK_FALSE otherwise

See also

SetInvertText

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.

GetMiddleLeftText()

Dtk_Text Dtk_Roughness::GetMiddleLeftText

(

)

const

Gets the middle-left text - read only -.

Returns

The middle-left text

See also

SetMiddleLeftText

GetMiddleRightText()

Dtk_Text Dtk_Roughness::GetMiddleRightText

(

)

const

Gets the middle-right text - read only -.

Returns

The middle-right text

See also

SetMiddleRightText

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

GetOtherRequirement()

Dtk_Text Dtk_Roughness::GetOtherRequirement

(

)

const

Gets the OtherRequirement text - read only -.

Returns

The OtherRequirement text

See also

SetOtherRequirement

GetOuterBoundingBox()

Dtk_Oriented2dBBox Dtk_Roughness::GetOuterBoundingBox

(

const Dtk_bool

inIncludeSymbolGeometry

)

const

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.

GetRoughMode()

RoughModeEnum Dtk_Roughness::GetRoughMode

(

)

const

Gets the rough mode - read only -.

Returns

The rough mode

See also

SetRoughMode

GetRoughnessApplyTo()

ApplyToEnum Dtk_Roughness::GetRoughnessApplyTo

(

)

const

Gets the apply-to type - read only -.

Returns

The apply-to type

See also

SetRoughnessApplyTo

GetRoughnessType()

ObtentionTypeEnum Dtk_Roughness::GetRoughnessType

(

)

const

Gets the obtention type - read only -.

Returns

The obtention type

See also

SetRoughnessType

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.

GetSymbolColor()

void Dtk_Roughness::GetSymbolColor

(

Dtk_Int32 &

outColorId

)

const

get the color of the Symbol

Parameters

outColor

: the color of the symbol.

GetTopLeftText()

Dtk_Text Dtk_Roughness::GetTopLeftText

(

)

const

Gets the top-left text - read only -.

Returns

The top-left text

See also

SetTopLeftText

GetTopRightText()

Dtk_Text Dtk_Roughness::GetTopRightText

(

)

const

Gets the top-right text - read only -.

Returns

The top-right text

See also

SetTopRightText

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_Roughness& Dtk_Roughness::operator=

(

const Dtk_Roughness &

in

)

Copy assignment operator.

Parameters

in	Object to copy from.

PrepareTransfo()

virtual void Dtk_Entity::PrepareTransfo ( )

virtualinherited

Reimplemented in Dtk_OffsetSurface.

ProcessSymbolInfos()

void Dtk_Roughness::ProcessSymbolInfos	(	Dtk_tab< Dtk_pnt > &	outPnts,
		Dtk_Double64 &	outCircleRadius
	)		const

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

Parameters

outPnts	The reference points processed.
outCircleRadius	The circle radius processed.

Reverse()

virtual Dtk_ErrorStatus Dtk_Annotation::Reverse ( )

virtualinherited

Reverses the Dtk_Annotation.

Reimplemented in Dtk_DatumTarget.

rough_mode_to_Dtk_Text()

Dtk_Text Dtk_Roughness::rough_mode_to_Dtk_Text

(

)

const

Converts the rough mode into a Dtk_Text - used to Dtk_Symbol conversion -.

SetAnchorPoint()

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

virtual

Sets the Dtk_Roughness 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

SetBottomLeftText()

Dtk_ErrorStatus Dtk_Roughness::SetBottomLeftText

(

Dtk_Text

inText

)

Sets the bottom-left text.

Parameters

inText

The new text.

Returns

dtkNoError if OK

See also

GetBottomLeftText

SetBottomRightText()

Dtk_ErrorStatus Dtk_Roughness::SetBottomRightText

(

Dtk_Text

inText

)

Sets the bottom-right text.

Parameters

inText

The new text.

Returns

dtkNoError if OK

See also

GetBottomRightText

SetCutOff()

Dtk_ErrorStatus Dtk_Roughness::SetCutOff

(

Dtk_Text

inText

)

Sets the CutOff text.

Parameters

inText

The new CutOff text.

Returns

dtkNoError if OK

See also

GetCutOff

SetInvertText()

void Dtk_Roughness::SetInvertText

(

Dtk_Int32

inValue = DTK_FALSE

)

Sets text are invert.

Parameters

inValue

DTK_TRUE all text are invert

See also

GetInvertText

SetLocation() [1/2]

Dtk_ErrorStatus Dtk_Roughness::SetLocation ( const Dtk_pnt &  inLocation )

virtual

Sets the location point of the Dtk_Annotation.

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

SetMiddleLeftText()

Dtk_ErrorStatus Dtk_Roughness::SetMiddleLeftText

(

Dtk_Text

inText

)

Sets the middle-left text.

Parameters

inText

The new text.

Returns

dtkNoError if OK

See also

GetMiddleLeftText

SetMiddleRightText()

Dtk_ErrorStatus Dtk_Roughness::SetMiddleRightText

(

Dtk_Text

inText

)

Sets the middle-right text.

Parameters

inText

The new text.

Returns

dtkNoError if OK

See also

GetMiddleRightText

SetOffset()

Dtk_ErrorStatus Dtk_Roughness::SetOffset ( const Dtk_Double64 &  inOffset )

virtual

Sets the offset of the Dtk_Annotation.

The Offset is used to process bounding frames.

Parameters

inOffset

The offset

Returns

dtkNoError if OK

Warning

For internal use only

Implements Dtk_Annotation.

SetOtherRequirement()

Dtk_ErrorStatus Dtk_Roughness::SetOtherRequirement

(

Dtk_Text

inText

)

Sets the OtherRequirement text.

Parameters

inText

The new OtherRequirement text.

Returns

dtkNoError if OK

See also

GetOtherRequirement

SetRotationAngle()

Dtk_ErrorStatus Dtk_Roughness::SetRotationAngle ( const Dtk_Double64 &  angle )

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.

SetRoughMode()

Dtk_ErrorStatus Dtk_Roughness::SetRoughMode

(

Dtk_Text

inRoughModeText

)

Sets the rough mode.

Parameters

inRoughMode

The new rough mode - in Text form -.

Returns

dtkNoError if OK

See also

GetRoughMode

SetRoughnessApplyTo()

Dtk_ErrorStatus Dtk_Roughness::SetRoughnessApplyTo

(

const ApplyToEnum &

inApplyTo

)

Sets the apply-to type.

Parameters

inApplyTo

The new apply-to type.

Returns

dtkNoError if OK

See also

GetTopLeftText

SetRoughnessType()

Dtk_ErrorStatus Dtk_Roughness::SetRoughnessType

(

const ObtentionTypeEnum &

inObtentionType

)

Sets the obtention type.

Parameters

inObtentionType

The obtention type.

Returns

dtkNoError if OK

See also

GetRoughnessType

SetSymbolColor()

void Dtk_Roughness::SetSymbolColor

(

Dtk_Int32

inColorId

)

const

set the color of the Symbol

Parameters

inColor

: the color of the symbol.

SetTopLeftText()

Dtk_ErrorStatus Dtk_Roughness::SetTopLeftText

(

Dtk_Text

inText

)

Sets the top-left text.

Parameters

inText

The new text.

Returns

dtkNoError if OK

See also

GetTopLeftText

SetTopRightText()

Dtk_ErrorStatus Dtk_Roughness::SetTopRightText

(

Dtk_Text

inText

)

Sets the top-right text.

Parameters

inText

The new text.

Returns

dtkNoError if OK

See also

GetTopRightText

Transform()

Dtk_ErrorStatus Dtk_Roughness::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_Roughness::Translate

(

const Dtk_dir &

inTranslationDir

)

Translates the Dtk_ReferenceBlock - internal use only -.

Parameters

inTranslationDir

the translation vector.

Field Documentation

_Private

Dtk_Handle* Dtk_Roughness::_Private

protected

count_

unsigned long Dtk_Object::count_

protectedinherited