Dtk_Fdt Class Reference

This is the FD&T class.
The base PMI Class contains a Dtk_2dEntity and Transformation Matrix to locate the FDT into 3D Space.
. More...

Inheritance diagram for Dtk_Fdt:

Public Types
enum	ScreenDisplayEnum { Default = 0, ParallelToScreen = 1, PinToScreen = 2 }

Public Member Functions
virtual Dtk_ErrorStatus	_Store (void *)
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
Dtk_ErrorStatus	GetDisplayBackgroundColorId (Dtk_Int32 &outColorIdData)
	Gets the DisplayBackground color id of the Dtk_Fdt. More...
const Dtk_ID &	GetID () const
	Get Internal UniqueID. More...
bool	GetIsZoomableAttribute () const
	Gets the Zoomable attribute of the Dtk_Fdt. More...
Dtk_Fdt::ScreenDisplayEnum	GetScreenDisplayAttribute () const
	Gets the ScreenDisplay attribute of the Dtk_Fdt. More...
virtual Dtk_Size_t	GetSize () const
Dtk_InfoPtr &	info ()
virtual void	PrepareTransfo ()
void	SetDisplayBackgroundColorId (Dtk_Int32 inData)
	Sets the DisplayBackground color id of the Dtk_Fdt. More...
void	SetIsZoomableAttribute (const bool &inBool)
	Sets the Zoomable attribute of the Dtk_Fdt. More...
void	SetScreenDisplayAttribute (const ScreenDisplayEnum inType)
	Sets the ScreenDisplay attribute of the Dtk_Fdt. More...
Dtk_2dEntityPtr &	Sub2DEntity ()
	Retrieves the sub 2D entity - get/set -. More...
const Dtk_2dEntityPtr &	Sub2DEntity () const
	Retrieves the sub 2D entity - read only -. More...
Dtk_ErrorStatus	Transform (const Dtk_transfo &inTransfo)
	Applies a transformation matrix to the entity. //! More...
Dtk_transfo &	TransformationMatrix ()
	Retrieves the transformation matrix - get/set -. More...
const Dtk_transfo &	TransformationMatrix () const
	Retrieves the transformation matrix - read only -. More...

Static Public Member Functions
static Dtk_FdtPtr	Create ()
	Calls default constructor to allocate a new object. More...
static Dtk_FdtPtr	Create (const Dtk_Fdt &s)
	Calls copy constructor to allocate a new object. More...
static Dtk_FdtPtr	Create (const Dtk_transfo &inTransformationMatrix, const Dtk_2dEntityPtr &inSub2DEntity)
	Calls full featured constructor to allocate a new object. More...
static Dtk_FdtPtr	Create (Dtk_Fdt &&inToBeMoved)
	Calls move constructor to allocate a new object. More...
static Dtk_Fdt *	DtkDynamicCast (Dtk_Object *s)
	Performs a dynamic cast - doesn't need RTTI -. More...
static Dtk_string	ScreenDisplayEnumToString (const ScreenDisplayEnum &inEnum)

Protected Types
enum	{ _typeID = DTK_TYPE_OBJECT }
enum	{ _typeID = DTK_TYPE_ENTITY }
enum	{ _typeID = DTK_TYPE_FDT }

Protected Member Functions
void	_copy (const Dtk_Entity &s)
void	_init ()
void	_reset ()
virtual Dtk_Object *	Clone ()
	Dtk_Fdt ()
	Dtk_Fdt (const Dtk_Fdt &inToBeCopied)
	Dtk_Fdt (const Dtk_transfo &inTransforansform, const Dtk_2dEntityPtr &entity2D)
	Dtk_Fdt (Dtk_Fdt &&inToBeMoved) DTK_NOEXCEPT
virtual	~Dtk_Fdt ()
	Destructor. More...

Protected Attributes
Dtk_Handle *	_Private
unsigned long	count_

Detailed Description

This is the FD&T class.
The base PMI Class contains a Dtk_2dEntity and Transformation Matrix to locate the FDT into 3D Space.
.

See also

Use Dtk_FdtPtr class to handle it.

Member Enumeration Documentation

anonymous enum

anonymous enum

protectedinherited

Enumerator
_typeID

{ _typeID = DTK_TYPE_OBJECT }; 

anonymous enum

anonymous enum

protectedinherited

Enumerator
_typeID

{ _typeID = DTK_TYPE_ENTITY };

anonymous enum

anonymous enum

protected

Enumerator
_typeID

    {
        _typeID = DTK_TYPE_FDT
    };

ScreenDisplayEnum

enum Dtk_Fdt::ScreenDisplayEnum

Enumerator
Default	The annotation display isn't bound to the viewport.
ParallelToScreen	Keep the annotation facing the viewport - Rotate won't have effect on annotation display -. Pan/Zoom WILL have effect on annotation display.
PinToScreen	Keep the annotation facing the viewport - Rotate won't have effect on annotation display -. Pan and zoom also WON'T have effect on annotation display. Coordinates are screen ratio between 0.0 and 1.0, Origin at bottom left.

    { 
        Default             = 0, 
        ParallelToScreen    = 1,
        PinToScreen         = 2  
    };

Constructor & Destructor Documentation

Dtk_Fdt() [1/4]

Dtk_Fdt::Dtk_Fdt ( )

protected

See also

Create()

Dtk_Fdt() [2/4]

Dtk_Fdt::Dtk_Fdt ( const Dtk_Fdt &  inToBeCopied )

protected

See also

Create(const Dtk_Fdt &)

Dtk_Fdt() [3/4]

Dtk_Fdt::Dtk_Fdt ( Dtk_Fdt &&  inToBeMoved )

protected

See also

Create(Dtk_Fdt&& )

Dtk_Fdt() [4/4]

Dtk_Fdt::Dtk_Fdt ( const Dtk_transfo &  inTransforansform, const Dtk_2dEntityPtr &  entity2D  )

protected

See also

Create(const Dtk_transfo &, const Dtk_2dEntityPtr &)

~Dtk_Fdt()

virtual Dtk_Fdt::~Dtk_Fdt ( )

protectedvirtual

Destructor.

Member Function Documentation

_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.

Clone()

virtual Dtk_Object* Dtk_Fdt::Clone ( )

protectedvirtual

Implements Dtk_Entity.

{ return new Dtk_Fdt(*this); }

Create() [1/4]

static Dtk_FdtPtr Dtk_Fdt::Create ( )

static

Calls default constructor to allocate a new object.

Create() [2/4]

static Dtk_FdtPtr Dtk_Fdt::Create ( const Dtk_Fdt &  s )

static

Calls copy constructor to allocate a new object.

Parameters

inToBeCopied

Object to copy from.

Create() [3/4]

static Dtk_FdtPtr Dtk_Fdt::Create ( const Dtk_transfo &  inTransformationMatrix, const Dtk_2dEntityPtr &  inSub2DEntity  )

static

Calls full featured constructor to allocate a new object.

Parameters

inTransformationMatrix	The Transformation Matrix
inSub2DEntity	The sub 2D entity

Create() [4/4]

static Dtk_FdtPtr Dtk_Fdt::Create ( Dtk_Fdt &&  inToBeMoved )

static

Calls move constructor to allocate a new object.

Parameters

inToBeMoved

Object to move from.

DtkDynamicCast()

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

static

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

DtkDynamicType() [1/2]

Dtk_Int32 Dtk_Fdt::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_Fdt::get_type_detk ( ) const

virtual

Returns

The type of the entity type - DTK_TYPE_FDT -

Implements Dtk_Entity.

    {
        return DTK_TYPE_FDT;
    }

GetDisplayBackgroundColorId()

Dtk_ErrorStatus Dtk_Fdt::GetDisplayBackgroundColorId

(

Dtk_Int32 &

outColorIdData

)

Gets the DisplayBackground color id of the Dtk_Fdt.

Parameters

outColorIdData

: if present the color id >=0

Returns

if present dtkNoError otherwise dtkErrorUnspecified

See also

GetDisplayBackgroundColorId()

GetID()

const Dtk_ID& Dtk_Entity::GetID ( ) const

inherited

Get Internal UniqueID.

Returns

InternalID

GetIsZoomableAttribute()

bool Dtk_Fdt::GetIsZoomableAttribute

(

)

const

Gets the Zoomable attribute of the Dtk_Fdt.

Returns

The Dtk_Fdt Zoomable attribute

See also

GetIsZoomableAttribute() const

GetScreenDisplayAttribute()

Dtk_Fdt::ScreenDisplayEnum Dtk_Fdt::GetScreenDisplayAttribute

(

)

const

Gets the ScreenDisplay attribute of the Dtk_Fdt.

Returns

The Dtk_Fdt ScreenDisplay attribute

See also

GetScreenDisplayAttribute() const

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.

info()

Dtk_InfoPtr& Dtk_Entity::info ( )

inherited

PrepareTransfo()

virtual void Dtk_Entity::PrepareTransfo ( )

virtualinherited

Reimplemented in Dtk_OffsetSurface.

ScreenDisplayEnumToString()

static Dtk_string Dtk_Fdt::ScreenDisplayEnumToString ( const ScreenDisplayEnum &  inEnum )

static

    {
        switch( inEnum )
        {
        default:
        case Default:           return L"Default";
        case ParallelToScreen:  return L"ParallelToScreen";
        case PinToScreen:       return L"PinToScreen";
        }
    }

SetDisplayBackgroundColorId()

void Dtk_Fdt::SetDisplayBackgroundColorId

(

Dtk_Int32

inData

)

Sets the DisplayBackground color id of the Dtk_Fdt.

Parameters

inData

the color id

See also

SetDisplayBackgroundColorId()

SetIsZoomableAttribute()

void Dtk_Fdt::SetIsZoomableAttribute

(

const bool &

inBool

)

Sets the Zoomable attribute of the Dtk_Fdt.

Parameters

inBool

The Dtk_Fdt zoomable attribute

See also

SetIsZoomableAttribute() const

Remarks

: by default fdt will be zoomable

SetScreenDisplayAttribute()

void Dtk_Fdt::SetScreenDisplayAttribute

(

const ScreenDisplayEnum

inType

)

Sets the ScreenDisplay attribute of the Dtk_Fdt.

Parameters

inType

The Dtk_Fdt ScreenDisplay attribute

See also

SetScreenDisplayAttribute()

Sub2DEntity() [1/2]

Dtk_2dEntityPtr& Dtk_Fdt::Sub2DEntity

(

)

Retrieves the sub 2D entity - get/set -.

Returns

The sub 2D entity.

See also

Sub2DEntity() const

Sub2DEntity() [2/2]

const Dtk_2dEntityPtr& Dtk_Fdt::Sub2DEntity

(

)

const

Retrieves the sub 2D entity - read only -.

Returns

The sub 2D entity.

See also

Sub2DEntity()

Transform()

Dtk_ErrorStatus Dtk_Fdt::Transform ( const Dtk_transfo &  inTransfo )

virtual

Applies a transformation matrix to the entity. //!

Parameters

inTransfo

The transformation matrix to apply.

Implements Dtk_Entity.

TransformationMatrix() [1/2]

Dtk_transfo& Dtk_Fdt::TransformationMatrix

(

)

Retrieves the transformation matrix - get/set -.

Returns

The transformation matrix.

See also

TransformationMatrix() const

TransformationMatrix() [2/2]

const Dtk_transfo& Dtk_Fdt::TransformationMatrix

(

)

const

Retrieves the transformation matrix - read only -.

Returns

The transformation matrix.

See also

TransformationMatrix()

Field Documentation

_Private

Dtk_Handle* Dtk_Fdt::_Private

protected

count_

unsigned long Dtk_Object::count_

protectedinherited