Dtk_Grid Class Reference

Represents the grids. More...

Inheritance diagram for Dtk_Grid:

Public Types
enum	OriginReferenceOption { Absolute, WCS, Local }
enum	ShowLabelOption { None, ParallelToView, Always }

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...
void	DrawLabelsInOriginUnit (const Dtk_bool &inVal)
	Draws Labels in millimeters or in origin unit. 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]) const
	Processes all the Dtk_Annotation anchor points. More...
Dtk_Oriented2dBBox &	GetBoundingBox () const
	Gets the 2d bbox of the grid. More...
Dtk_bool	GetDisplayGridOption () const
	Gets the display grid option. More...
Dtk_bool	GetDisplayMajorLinesOption () const
	Gets the display major lines option. More...
Dtk_bool	GetDisplayOnTopOption () const
	Gets the display on top option. More...
OriginReferenceOption	GetDisplayOriginReferenceOption () const
	Gets the display origin reference option. More...
ShowLabelOption	GetDisplayShowLabelOption () const
	Gets the display show labels option. More...
Dtk_tab< Dtk_EntityPtr >	GetGeometries () const
	Retrieves the Dtk_Grid geometries. More...
const Dtk_ID &	GetID () const
	Get Internal UniqueID. More...
Dtk_CompositeText	GetLabelsAsCompositeTexts () const
	Retrieves the Dtk_Grid labels. 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_FontLineType	GetMajorLineStyle () const
	Gets the major line font line type. More...
Dtk_Double64	GetMajorLineWidth () const
	Gets the major line width. More...
Dtk_FontLineType	GetMinorLineStyle () const
	Gets the minor line font line type. More...
Dtk_Double64	GetMinorLineWidth () const
	Gets the minor line width. More...
Dtk_Size_t	GetNumLeaders () const
	Retrieves the number of leaders. More...
Dtk_Double64	GetOffset () const
	Gets the annotation offset - read only -. 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_Int32	GetUMinorPerMajor () const
	Gets U minor lines per major. More...
Dtk_Double64	GetUSpacing () const
	Gets U spacing between lines. More...
Dtk_Int32	GetVMinorPerMajor () const
	Gets V minor lines per major. More...
Dtk_Double64	GetVSpacing () const
	Gets V spacing between lines. 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 ()
virtual std::ostream &	operator<< (std::ostream &o) const
virtual void	PrepareTransfo ()
virtual Dtk_ErrorStatus	Reverse ()
	Reverses the Dtk_Annotation. More...
Dtk_ErrorStatus	SetAnchorPoint (const Dtk_pnt &inNewLocation, const Dtk_anchor_type &inLocationAnchorType)
	Sets the Dtk_Annotation anchor point. More...
	SetAsDeprecated ("Undefined", "Use Dtk_TextStyle::Justification()") Dtk_justication_type GetJustification() const
	Get the justification type - read only -. 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_Annotation. More...
virtual Dtk_ErrorStatus	SetRotationAngle (const Dtk_Double64 &inRotationAngle)
	Sets the annotation angle using the annotation base. More...
Dtk_ErrorStatus	Transform (const Dtk_transfo &inTransfo)
	Applies a transformation matrix to the entity. //! More...

Static Public Member Functions
static Dtk_GridPtr	Create (const Dtk_Grid &grid)
	CopyConstructor{inTobCopied}. More...
static Dtk_GridPtr	Create (const Dtk_Oriented2dBBox &inUVBBox, const Dtk_Double64 &inUSpacing, const Dtk_Double64 &inVSpacing, const Dtk_Int32 &inUMinorPerMajor=1, const Dtk_Int32 &inVMinorPerMajor=1, const Dtk_RGB &inLineColor=Dtk_RGB(), const Dtk_FontLineType &inMajorLineStyle=DTK_NO_PATTERN, const Dtk_FontLineType &inMinorLineStyle=DTK_NO_PATTERN, const Dtk_Double64 &inMajorLineWidth=1.0, const Dtk_Double64 &inMinorLineWidth=1.0, const Dtk_bool &inDisplayGridOpt=DTK_TRUE, const Dtk_bool &inDisplayOnTopOpt=DTK_TRUE, const Dtk_bool &inDisplayMajorLinesOpt=DTK_FALSE, const ShowLabelOption &inShowLabelOpt=Dtk_Grid::Always, const OriginReferenceOption &inOriginReferenceOpt=Dtk_Grid::Local, const Dtk_Double64 &inConceptionUnit=1.0)
	Full featured constructor. More...
static Dtk_Grid *	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_GRID }

Protected Member Functions
void	_Copy (const Dtk_2dEntity &s)
void	_copy (const Dtk_Entity &s)
void	_copy (const Dtk_Object &s)
void	_init ()
void	_reset ()
virtual Dtk_Object *	Clone ()
	Dtk_Grid ()
	Base constructor. More...
	Dtk_Grid (const Dtk_Grid &grid)
	Dtk_Grid (const Dtk_Oriented2dBBox &inUVBBox, const Dtk_Double64 &inUSpacing, const Dtk_Double64 &inVSpacing, const Dtk_Int32 &inUMinorPerMajor, const Dtk_Int32 &inVMinorPerMajor, const Dtk_RGB &inLineColor, const Dtk_FontLineType &inMajorLineStyle, const Dtk_FontLineType &inMinorLineStyle, const Dtk_Double64 &inMajorLineWidth, const Dtk_Double64 &inMinorLineWidth, const Dtk_bool &inDisplayGridOpt, const Dtk_bool &inDisplayOnTopOpt, const Dtk_bool &inDisplayMajorLinesOpt, const ShowLabelOption &inShowLabelOpt, const OriginReferenceOption &inOriginReferenceOpt, const Dtk_Double64 &inConceptionUnit)
	~Dtk_Grid ()
	Destructor. More...

Protected Attributes
Dtk_Handle *	_Private
unsigned long	count_

Friends
class	Dtk_SmartPtr< Dtk_Grid >

Detailed Description

Represents the grids.

Example:

Here is a grid with 3 minor lines per major in U and V directions

See also

Please use the Dtk_GridPtr 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_GRID
    };

OriginReferenceOption

enum Dtk_Grid::OriginReferenceOption

Enumerator
Absolute
WCS
Local

    {
        Absolute,
        WCS,
        Local
    };

ShowLabelOption

enum Dtk_Grid::ShowLabelOption

Enumerator
None
ParallelToView
Always

    {
        None,
        ParallelToView,
        Always
    };

Constructor & Destructor Documentation

Dtk_Grid() [1/3]

Dtk_Grid::Dtk_Grid ( )

protected

Base constructor.

                :
          _Private( nullptr )
     {
     };

Dtk_Grid() [2/3]

Dtk_Grid::Dtk_Grid ( const Dtk_Grid &  grid )

protected

See also

create(const Dtk_Grid &)

Dtk_Grid() [3/3]

Dtk_Grid::Dtk_Grid ( const Dtk_Oriented2dBBox &  inUVBBox, const Dtk_Double64 &  inUSpacing, const Dtk_Double64 &  inVSpacing, const Dtk_Int32 &  inUMinorPerMajor, const Dtk_Int32 &  inVMinorPerMajor, const Dtk_RGB &  inLineColor, const Dtk_FontLineType &  inMajorLineStyle, const Dtk_FontLineType &  inMinorLineStyle, const Dtk_Double64 &  inMajorLineWidth, const Dtk_Double64 &  inMinorLineWidth, const Dtk_bool &  inDisplayGridOpt, const Dtk_bool &  inDisplayOnTopOpt, const Dtk_bool &  inDisplayMajorLinesOpt, const ShowLabelOption &  inShowLabelOpt, const OriginReferenceOption &  inOriginReferenceOpt, const Dtk_Double64 &  inConceptionUnit  )

protected

~Dtk_Grid()

Dtk_Grid::~Dtk_Grid ( )

protected

Destructor.

Member Function Documentation

_Copy()

void Dtk_2dEntity::_Copy ( const Dtk_2dEntity &  s )

protectedinherited

_copy() [1/2]

void Dtk_Entity::_copy ( const Dtk_Entity &  s )

protectedinherited

_copy() [2/2]

void Dtk_Object::_copy ( const Dtk_Object &  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.

Clone()

virtual Dtk_Object* Dtk_Grid::Clone ( )

protectedvirtual

Implements Dtk_Annotation.

{ return new Dtk_Grid(*this); }

Create() [1/2]

static Dtk_GridPtr Dtk_Grid::Create ( const Dtk_Grid &  grid )

static

CopyConstructor{inTobCopied}.

Create() [2/2]

static Dtk_GridPtr Dtk_Grid::Create ( const Dtk_Oriented2dBBox &  inUVBBox, const Dtk_Double64 &  inUSpacing, const Dtk_Double64 &  inVSpacing, const Dtk_Int32 &  inUMinorPerMajor = 1, const Dtk_Int32 &  inVMinorPerMajor = 1, const Dtk_RGB &  inLineColor = Dtk_RGB(), const Dtk_FontLineType &  inMajorLineStyle = DTK_NO_PATTERN, const Dtk_FontLineType &  inMinorLineStyle = DTK_NO_PATTERN, const Dtk_Double64 &  inMajorLineWidth = 1.0, const Dtk_Double64 &  inMinorLineWidth = 1.0, const Dtk_bool &  inDisplayGridOpt = DTK_TRUE, const Dtk_bool &  inDisplayOnTopOpt = DTK_TRUE, const Dtk_bool &  inDisplayMajorLinesOpt = DTK_FALSE, const ShowLabelOption &  inShowLabelOpt = Dtk_Grid::Always, const OriginReferenceOption &  inOriginReferenceOpt = Dtk_Grid::Local, const Dtk_Double64 &  inConceptionUnit = 1.0  )

static

Full featured constructor.

Parameters

inUVBBox	Bounding box of the grid
inUSpacing	U spacing between lines
inVSpacing	v spacing between lines
inUMinorPerMajor	U number of minor lines per major lines
inVMinorPerMajor	V number of minor lines per major lines
inLineColor	Grid Color
inMajorLineStyle	Major lines style
inMinorLineStyle	Minor lines style
inMajorLineWidth	Major lines width
inMinorLineWidth	Minor lines width

Returns

The created Dtk_GridPtr

DrawLabelsInOriginUnit()

void Dtk_Grid::DrawLabelsInOriginUnit

(

const Dtk_bool &

inVal

)

Draws Labels in millimeters or in origin unit.

Parameters

inVal

: Draws Labels in millimeters (DTK_FALSE) or in origin unit (DTK_TRUE)

Remarks

: by default labels will be drawn in millimeters

DtkDynamicCast()

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

static

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

DtkDynamicType() [1/2]

Dtk_Int32 Dtk_Grid::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_Grid::get_type_detk ( ) const

virtual

Returns

The type of the entity type - DTK_TYPE_GRID-

Implements Dtk_Annotation.

{ return DTK_TYPE_GRID; }

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

Dtk_ErrorStatus Dtk_Grid::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.

GetBoundingBox()

Dtk_Oriented2dBBox& Dtk_Grid::GetBoundingBox

(

)

const

Gets the 2d bbox of the grid.

Returns

the bbox

GetDisplayGridOption()

Dtk_bool Dtk_Grid::GetDisplayGridOption

(

)

const

Gets the display grid option.

Returns

the display grid option

DTK_TRUE if grid is visible

DTK_FALSE if grid is invisible

GetDisplayMajorLinesOption()

Dtk_bool Dtk_Grid::GetDisplayMajorLinesOption

(

)

const

Gets the display major lines option.

Returns

the display major lines option

DTK_TRUE if displays major lines with style

DTK_FALSE if all major and minor have same style

GetDisplayOnTopOption()

Dtk_bool Dtk_Grid::GetDisplayOnTopOption

(

)

const

Gets the display on top option.

Returns

the display on top option

DTK_TRUE if grid stays on top of other entities,

DTK_FALSE if it is hidden by other entities displayed in front of it

GetDisplayOriginReferenceOption()

OriginReferenceOption Dtk_Grid::GetDisplayOriginReferenceOption

(

)

const

Gets the display origin reference option.

Returns

the display origin reference option

an enum indicating wether the origin of the grid is given in Absolute coordinates (Absolute), \in World Coordinate System (WCS) coordinates or in Local coordinates (Local)

GetDisplayShowLabelOption()

ShowLabelOption Dtk_Grid::GetDisplayShowLabelOption

(

)

const

Gets the display show labels option.

Returns

the display show labels option

an enum indicating wether labels are hidden(None), \stays parallel to screen(ParallelToView) or displayed in grid plane(Always)

GetGeometries()

Dtk_tab< Dtk_EntityPtr > Dtk_Grid::GetGeometries

(

)

const

Retrieves the Dtk_Grid geometries.

Returns

All the associated geometries asked.

GetID()

const Dtk_ID& Dtk_Entity::GetID ( ) const

inherited

Get Internal UniqueID.

Returns

InternalID

GetLabelsAsCompositeTexts()

Dtk_CompositeText Dtk_Grid::GetLabelsAsCompositeTexts

(

)

const

Retrieves the Dtk_Grid labels.

Returns

All the labels as composite texts.

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.

GetMajorLineStyle()

Dtk_FontLineType Dtk_Grid::GetMajorLineStyle

(

)

const

Gets the major line font line type.

Returns

the major line font line type

GetMajorLineWidth()

Dtk_Double64 Dtk_Grid::GetMajorLineWidth

(

)

const

Gets the major line width.

Returns

the major line width

GetMinorLineStyle()

Dtk_FontLineType Dtk_Grid::GetMinorLineStyle

(

)

const

Gets the minor line font line type.

Returns

the minor line font line type

GetMinorLineWidth()

Dtk_Double64 Dtk_Grid::GetMinorLineWidth

(

)

const

Gets the minor line width.

Returns

the minor line width

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

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.

GetUMinorPerMajor()

Dtk_Int32 Dtk_Grid::GetUMinorPerMajor

(

)

const

Gets U minor lines per major.

Returns

U number of minor lines per major

GetUSpacing()

Dtk_Double64 Dtk_Grid::GetUSpacing

(

)

const

Gets U spacing between lines.

Returns

U spacing

GetVMinorPerMajor()

Dtk_Int32 Dtk_Grid::GetVMinorPerMajor

(

)

const

Gets V minor lines per major.

Returns

V number of minor lines per major

GetVSpacing()

Dtk_Double64 Dtk_Grid::GetVSpacing

(

)

const

Gets V spacing between lines.

Returns

V spacing

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

virtual std::ostream& Dtk_2dEntity::operator<< ( std::ostream &  o ) const

virtualinherited

     {
          return o << "Dtk_2dEntity Base class";
     }

PrepareTransfo()

virtual void Dtk_Entity::PrepareTransfo ( )

virtualinherited

Reimplemented in Dtk_OffsetSurface.

Reverse()

virtual Dtk_ErrorStatus Dtk_Annotation::Reverse ( )

virtualinherited

Reverses the Dtk_Annotation.

Reimplemented in Dtk_DatumTarget.

SetAnchorPoint()

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

virtual

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

SetLocation() [1/2]

Dtk_ErrorStatus Dtk_Grid::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

SetOffset()

Dtk_ErrorStatus Dtk_Grid::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

Implements Dtk_Annotation.

SetRotationAngle()

virtual Dtk_ErrorStatus Dtk_Annotation::SetRotationAngle ( const Dtk_Double64 &  inRotationAngle )

virtualinherited

Sets the annotation angle using the annotation base.

Parameters

inRotationAngle

The rotation angle to be set

Returns

dtkNoError if OK

Reimplemented in Dtk_Symbol, Dtk_GeometricalTolerance, Dtk_Table, Dtk_DatumTarget, Dtk_Welding, and Dtk_Roughness.

Transform()

Dtk_ErrorStatus Dtk_Grid::Transform ( const Dtk_transfo &  inTransfo )

virtual

Applies a transformation matrix to the entity. //!

Parameters

inTransfo

The transformation matrix to apply.

Implements Dtk_Annotation.

Friends And Related Function Documentation

Dtk_SmartPtr< Dtk_Grid >

friend class Dtk_SmartPtr< Dtk_Grid >

friend

Field Documentation

_Private

Dtk_Handle* Dtk_Grid::_Private

protected

count_

unsigned long Dtk_Object::count_

protectedinherited