This is the Dtk_Constraint class. More...

Inheritance diagram for Dtk_Constraint:

Data Structures
class	_ConstraintValue

Public Types
enum	ConstraintOrientationTypeEnum { ValueTypeUndefined = 0, ValueTypeSame, ValueTypeOpposite, ValueTypeInternal, ValueTypeExternal }

enum	ConstraintTypeEnum { TypeUnknown = 0, TypeAlign, TypeAngle, TypeBond, TypeCam, TypeCenter, TypeConcentric, TypeCoincidence, TypeDistance, TypeFit, TypeFix, TypeGear, TypeHinge, TypeLimit, TypeLinear, TypeLinearCoupler, TypeLock, TypeOrientAngle, TypeParallel, TypePathMate, TypePerpendicular, TypeProfileCenter, TypeRackPinion, TypeScrew, TypeSlot, TypeSymmetric, TypeTangent, TypeTouch, TypeUniversalJoint, TypeWidth }

enum	ConstraintValueTypeEnum { ValueTypeUnknown = 0, ValueTypeAngle, ValueTypeDistance, ValueTypePosition, ValueTypeRotation, ValueTypeOrientation }

Public Member Functions
virtual Dtk_ErrorStatus	_Store (void *)

void	AddConstraintReference (const Dtk_ConstraintReferencePtr &in)
	Add a ConstraintReference to this Constraint . More...

virtual void	conv_ptr (Dtk_Constraint **s)

	Dtk_Constraint (const ConstraintTypeEnum &inType)

	Dtk_Constraint (const Dtk_Constraint &p)

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_ConstraintReferencePtr > &	GetConstraintReference () const
	Get all ConstraintReferences of the Constraint. More...

const Dtk_ConstraintReferencePtr &	GetConstraintReference (const Dtk_Size_t &index) const
	Get the Dtk_ConstraintReference at the specified index. More...

const ConstraintTypeEnum &	GetConstraintType () const
	Get the type of the Constraint . More...

const _ConstraintValue &	GetConstraintValue (const Dtk_Size_t &index) const
	Get the Dtk_Constraint::_ConstraintValue at the specified index. More...

const Dtk_ID &	GetID () const
	Get Internal UniqueID. More...

Dtk_Size_t	GetNumberOfConstraintReferences () const
	Get the number of Dtk_ConstraintReference in the constraint. More...

Dtk_Size_t	GetNumberOfConstraintValues ()
	Get the number of Dtk_Constraint::_ConstraintValue in the constraint. More...

virtual Dtk_Size_t	GetSize () const

Dtk_ErrorStatus	GetValue (const ConstraintValueTypeEnum &inValue, Dtk_Val &outValue) const

Dtk_ErrorStatus	GetValue (const ConstraintValueTypeEnum &inValue, Dtk_Val &outValue, Dtk_Int32 &outEnableLowerLimit, Dtk_Double64 &outLowerLimit, Dtk_Int32 &outEnableUpperLimit, Dtk_Double64 &outUpperLimit) const
	Get a Value of the Constraint . More...

Dtk_tab< ConstraintValueTypeEnum >	GetValuesTypes () const
	Get all types of values in the Constraint. More...

Dtk_InfoPtr &	info ()

Dtk_Constraint &	operator= (const Dtk_Constraint &p)

virtual void	PrepareTransfo ()

void	SetConstraintType (const ConstraintTypeEnum &in)
	Set the type of the Constraint . More...

void	SetValue (const ConstraintValueTypeEnum &inValueType, Dtk_Val &inValue)

void	SetValue (const ConstraintValueTypeEnum &inValueType, Dtk_Val &inValue, const Dtk_Int32 &inEnableLowerLimit, const Dtk_Double64 &inLowerLimit, const Dtk_Int32 &inEnableUpperLimit, const Dtk_Double64 &inUpperLimit)
	Set a Value of the Constraint . More...

Dtk_ErrorStatus	Transform (const Dtk_transfo &inTransfo)
	Applies a transformation matrix to the entity. //! More...

Static Public Member Functions
static Dtk_string	ConstraintOrientationTypeEnumToString (const ConstraintOrientationTypeEnum &inEnum)

static Dtk_string	ConstraintTypeEnumToString (const ConstraintTypeEnum &inEnum)

static Dtk_string	ConstraintValueTypeEnumToString (const ConstraintValueTypeEnum &inEnum)

static Dtk_SmartPtr< Dtk_Constraint >	Create ()
	Calls default constructor to allocate a new object. More...

static Dtk_Constraint *	DtkDynamicCast (Dtk_Object *inObject)

Protected Types
enum	{ _typeID = DTK_TYPE_OBJECT }

enum	{ _typeID = DTK_TYPE_ENTITY }

Protected Member Functions
void	_Copy (const Dtk_Constraint &s)

void	_copy (const Dtk_Entity &s)

void	_init ()

void	_Init ()

void	_reset ()

void	_Reset ()

virtual Dtk_Object *	Clone ()

	Dtk_Constraint ()

virtual	~Dtk_Constraint ()

Protected Attributes
Dtk_Handle *	_Private

unsigned long	count_

Detailed Description

This is the Dtk_Constraint class.

A Dtk_Constraint contains the AxisSystem definition which defines by its Name, statut and the Matrix

This class lets you use Dtk_Constraint.

See also: Use Dtk_ConstraintPtr class to handle it.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

protectedinherited

Enumerator
_typeID

10 { _typeID = DTK_TYPE_OBJECT };

◆ anonymous enum

anonymous enum

protectedinherited

Enumerator
_typeID

375 { _typeID = DTK_TYPE_ENTITY };

◆ ConstraintOrientationTypeEnum

enum Dtk_Constraint::ConstraintOrientationTypeEnum

Enumerator
ValueTypeUndefined
ValueTypeSame
ValueTypeOpposite
ValueTypeInternal
ValueTypeExternal

      {
           ValueTypeUndefined = 0,
           ValueTypeSame,
           ValueTypeOpposite,
           ValueTypeInternal,
           ValueTypeExternal,
      };

◆ ConstraintTypeEnum

enum Dtk_Constraint::ConstraintTypeEnum

Enumerator
TypeUnknown
TypeAlign
TypeAngle
TypeBond
TypeCam
TypeCenter
TypeConcentric
TypeCoincidence
TypeDistance
TypeFit
TypeFix
TypeGear
TypeHinge
TypeLimit
TypeLinear
TypeLinearCoupler
TypeLock
TypeOrientAngle
TypeParallel
TypePathMate
TypePerpendicular
TypeProfileCenter
TypeRackPinion
TypeScrew
TypeSlot
TypeSymmetric
TypeTangent
TypeTouch
TypeUniversalJoint
TypeWidth

      {
           TypeUnknown = 0,
           //! \image html align.png
           TypeAlign,
           //! \image html angle.png
           TypeAngle,
           //! \image html bond.png
           TypeBond,
           TypeCam,
           //! \image html center.png
           TypeCenter,
           //! \image html concentric.png
           TypeConcentric,
           //! \image html coincidence.png
           TypeCoincidence,
           //! \image html distance.png
           TypeDistance,
           //! \image html fit.png
           TypeFit,
           //! \image html fix.png
           TypeFix,
           TypeGear,
           TypeHinge,
           TypeLimit,
           TypeLinear,
           TypeLinearCoupler,
           //! \image html lock.png
           TypeLock,
           //! \image html orientangle.png
           TypeOrientAngle,
           //! \image html parallel.png
           TypeParallel,
           TypePathMate,
           //! \image html perpendicular.png
           TypePerpendicular,
           TypeProfileCenter,
           TypeRackPinion,
           TypeScrew,
           TypeSlot,
           //! \image html symmetric.png
           TypeSymmetric,
           //! \image html tangent.png
           TypeTangent,
           //! \image html touch.png
           TypeTouch,
           TypeUniversalJoint,
           TypeWidth
      };

◆ ConstraintValueTypeEnum

enum Dtk_Constraint::ConstraintValueTypeEnum

Enumerator
ValueTypeUnknown
ValueTypeAngle
ValueTypeDistance
ValueTypePosition
ValueTypeRotation
ValueTypeOrientation

      {
           ValueTypeUnknown = 0,
           ValueTypeAngle,
           ValueTypeDistance,
           ValueTypePosition,
           ValueTypeRotation,
           ValueTypeOrientation,
      };

Constructor & Destructor Documentation

◆ Dtk_Constraint() [1/3]

Dtk_Constraint::Dtk_Constraint ( const Dtk_Constraint & p )

◆ Dtk_Constraint() [2/3]

Dtk_Constraint::Dtk_Constraint ( const ConstraintTypeEnum & inType )

◆ Dtk_Constraint() [3/3]

Dtk_Constraint::Dtk_Constraint ( )

protected

◆ ~Dtk_Constraint()

virtual Dtk_Constraint::~Dtk_Constraint ( )

protectedvirtual

Member Function Documentation

◆ _Copy()

void Dtk_Constraint::_Copy ( const Dtk_Constraint & s )

protected

◆ _copy()

void Dtk_Entity::_copy ( const Dtk_Entity & s )

protectedinherited

◆ _init()

void Dtk_Entity::_init ( )

protectedinherited

◆ _Init()

void Dtk_Constraint::_Init ( )

protected

◆ _reset()

void Dtk_Entity::_reset ( )

protectedinherited

◆ _Reset()

void Dtk_Constraint::_Reset ( )

protected

◆ _Store()

virtual Dtk_ErrorStatus Dtk_Entity::_Store ( void * )

virtualinherited

◆ AddConstraintReference()

void Dtk_Constraint::AddConstraintReference ( const Dtk_ConstraintReferencePtr & in )

Add a ConstraintReference to this Constraint .

◆ Clone()

virtual Dtk_Object* Dtk_Constraint::Clone ( )

protectedvirtual

Implements Dtk_Entity.

1383 { return new Dtk_Constraint(*this); }

◆ ConstraintOrientationTypeEnumToString()

static Dtk_string Dtk_Constraint::ConstraintOrientationTypeEnumToString ( const ConstraintOrientationTypeEnum & inEnum )

static

      {
           switch( inEnum )
           {
                case ValueTypeSame:      return L"TypeSame";
                case ValueTypeOpposite:  return L"TypeOpposite";
                case ValueTypeInternal:  return L"TypeInternal";
                case ValueTypeExternal:  return L"TypeExternal";
                default:
                case ValueTypeUndefined: return L"TypeUndefined";
           }
      }

◆ ConstraintTypeEnumToString()

static Dtk_string Dtk_Constraint::ConstraintTypeEnumToString ( const ConstraintTypeEnum & inEnum )

static

      {
           switch (inEnum)
           {
           case TypeAlign:                return L"TypeAlign";
           case TypeAngle:                return L"TypeAngle";
           case TypeBond:                 return L"TypeBond";
           case TypeCam:                  return L"TypeCam";
           case TypeCenter:               return L"TypeCenter";
           case TypeConcentric:           return L"TypeConcentric";
           case TypeCoincidence:          return L"TypeCoincidence";
           case TypeDistance:             return L"TypeDistance";
           case TypeFit:                  return L"TypeFit";
           case TypeFix:                  return L"TypeFix";
           case TypeGear:                 return L"TypeGear";
           case TypeHinge:                return L"TypeHinge";
           case TypeLimit:                return L"TypeLimit";
           case TypeLinear:               return L"TypeLinear";
           case TypeLinearCoupler:        return L"TypeLinearCoupler";
           case TypeLock:                 return L"TypeLock";
           case TypeOrientAngle:          return L"TypeOrientAngle";
           case TypeParallel:             return L"TypeParallel";
           case TypePathMate:             return L"TypePathMate";
           case TypePerpendicular:        return L"TypePerpendicular";
           case TypeProfileCenter:        return L"TypeProfileCenter";
           case TypeRackPinion:           return L"TypeRackPinion";
           case TypeScrew:                return L"TypeScrew";
           case TypeSlot:                 return L"TypeSlot";
           case TypeSymmetric:            return L"TypeSymmetric";
           case TypeTangent:              return L"TypeTangent";
           case TypeTouch:                return L"TypeTouch";
           case TypeUniversalJoint:       return L"TypeUniversalJoint";
           case TypeWidth:                return L"TypeWidth";
           default:
           case TypeUnknown:              return L"Unknown";
           }
      }

◆ ConstraintValueTypeEnumToString()

static Dtk_string Dtk_Constraint::ConstraintValueTypeEnumToString ( const ConstraintValueTypeEnum & inEnum )

static

      {
           switch( inEnum )
           {
                case ValueTypeAngle:                    return L"Angle";
                case ValueTypeDistance:                 return L"Distance";
                case ValueTypePosition:                 return L"Position";
                case ValueTypeRotation:                 return L"Rotation";
                case ValueTypeOrientation:              return L"Orientation";
                default:
                case ValueTypeUnknown: return L"TypeUnknown";
           }
      }

◆ conv_ptr()

virtual void Dtk_Constraint::conv_ptr ( Dtk_Constraint ** s )

virtual

1368 { *s = this; }

◆ Create()

static Dtk_SmartPtr<Dtk_Constraint> Dtk_Constraint::Create ( )

static

Calls default constructor to allocate a new object.

◆ DtkDynamicCast()

static Dtk_Constraint* Dtk_Constraint::DtkDynamicCast ( Dtk_Object * inObject )

static

◆ DtkDynamicType()

int Dtk_Constraint::DtkDynamicType ( const int & inId )

virtual

Reimplemented from Dtk_Entity.

◆ 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_Constraint::get_type_detk ( ) const

virtual

Returns: The type of the entity type - DTK_TYPE_CONSTRAINT -

Implements Dtk_Entity.

1364 { return DTK_TYPE_CONSTRAINT; }

◆ GetConstraintReference() [1/2]

const Dtk_tab<Dtk_ConstraintReferencePtr>& Dtk_Constraint::GetConstraintReference ( ) const

Get all ConstraintReferences of the Constraint.

Returns: A tab with all the ConstraintReferences of this Constraint.

◆ GetConstraintReference() [2/2]

const Dtk_ConstraintReferencePtr& Dtk_Constraint::GetConstraintReference ( const Dtk_Size_t & index ) const

Get the Dtk_ConstraintReference at the specified index.

Parameters

The	index to retrieve the Dtk_ConstraintReference from.

Returns: A Dtk_ConstraintReference.

◆ GetConstraintType()

const ConstraintTypeEnum& Dtk_Constraint::GetConstraintType ( ) const

Get the type of the Constraint .

Returns: the type of this Constraint .

◆ GetConstraintValue()

const _ConstraintValue& Dtk_Constraint::GetConstraintValue ( const Dtk_Size_t & index ) const

Get the Dtk_Constraint::_ConstraintValue at the specified index.

Returns: A Dtk_Constraint::_ConstraintValue.

◆ GetID()

const Dtk_ID& Dtk_Entity::GetID ( ) const

inherited

Get Internal UniqueID.

Returns: InternalID

◆ GetNumberOfConstraintReferences()

Dtk_Size_t Dtk_Constraint::GetNumberOfConstraintReferences ( ) const

Get the number of Dtk_ConstraintReference in the constraint.

Returns: The number of Dtk_ConstraintReference in the constraint.

◆ GetNumberOfConstraintValues()

Dtk_Size_t Dtk_Constraint::GetNumberOfConstraintValues ( )

Get the number of Dtk_Constraint::_ConstraintValue in the constraint.

Returns: The number of Dtk_Constraint::_ConstraintValue in the constraint.

◆ GetSize()

virtual Dtk_Size_t Dtk_Entity::GetSize ( ) const

virtualinherited

◆ GetValue() [1/2]

Dtk_ErrorStatus Dtk_Constraint::GetValue	(	const ConstraintValueTypeEnum &	inValue,
		Dtk_Val &	outValue
	)		const

◆ GetValue() [2/2]

Dtk_ErrorStatus Dtk_Constraint::GetValue	(	const ConstraintValueTypeEnum &	inValue,
		Dtk_Val &	outValue,
		Dtk_Int32 &	outEnableLowerLimit,
		Dtk_Double64 &	outLowerLimit,
		Dtk_Int32 &	outEnableUpperLimit,
		Dtk_Double64 &	outUpperLimit
	)		const

Get a Value of the Constraint .

Returns: a Value of this Constraint .

◆ GetValuesTypes()

Dtk_tab< ConstraintValueTypeEnum > Dtk_Constraint::GetValuesTypes ( ) const

Get all types of values in the Constraint.

Returns: All types of values contained in the Constraint.

◆ info()

Dtk_InfoPtr& Dtk_Entity::info ( )

inherited

◆ operator=()

Dtk_Constraint& Dtk_Constraint::operator= ( const Dtk_Constraint & p )

◆ PrepareTransfo()

virtual void Dtk_Entity::PrepareTransfo ( )

virtualinherited

Reimplemented in Dtk_OffsetSurface.

◆ SetConstraintType()

void Dtk_Constraint::SetConstraintType ( const ConstraintTypeEnum & in )

Set the type of the Constraint .

◆ SetValue() [1/2]

void Dtk_Constraint::SetValue	(	const ConstraintValueTypeEnum &	inValueType,
		Dtk_Val &	inValue
	)

◆ SetValue() [2/2]

void Dtk_Constraint::SetValue	(	const ConstraintValueTypeEnum &	inValueType,
		Dtk_Val &	inValue,
		const Dtk_Int32 &	inEnableLowerLimit,
		const Dtk_Double64 &	inLowerLimit,
		const Dtk_Int32 &	inEnableUpperLimit,
		const Dtk_Double64 &	inUpperLimit
	)

Set a Value of the Constraint .

◆ Transform()

Dtk_ErrorStatus Dtk_Constraint::Transform ( const Dtk_transfo & inTransfo )

virtual

Applies a transformation matrix to the entity. //!

Parameters

inTransfo The transformation matrix to apply.

Implements Dtk_Entity.

Field Documentation

◆ _Private

Dtk_Handle* Dtk_Constraint::_Private

protected

◆ count_

unsigned long Dtk_Object::count_

protectedinherited

Data Structures

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

◆ anonymous enum

◆ ConstraintOrientationTypeEnum

◆ ConstraintTypeEnum

◆ ConstraintValueTypeEnum

Constructor & Destructor Documentation

◆ Dtk_Constraint() [1/3]

◆ Dtk_Constraint() [2/3]

◆ Dtk_Constraint() [3/3]

◆ ~Dtk_Constraint()

Member Function Documentation

◆ _Copy()

◆ _copy()

◆ _init()

◆ _Init()

◆ _reset()

◆ _Reset()

◆ _Store()

◆ AddConstraintReference()

◆ Clone()

◆ ConstraintOrientationTypeEnumToString()

◆ ConstraintTypeEnumToString()

◆ ConstraintValueTypeEnumToString()

◆ conv_ptr()

◆ Create()

◆ DtkDynamicCast()

◆ DtkDynamicType()

◆ dump()

◆ get_info()

◆ get_type_detk()

◆ GetConstraintReference() [1/2]

◆ GetConstraintReference() [2/2]

◆ GetConstraintType()

◆ GetConstraintValue()

◆ GetID()

◆ GetNumberOfConstraintReferences()

◆ GetNumberOfConstraintValues()

◆ GetSize()

◆ GetValue() [1/2]

◆ GetValue() [2/2]

◆ GetValuesTypes()

◆ info()

◆ operator=()

◆ PrepareTransfo()

◆ SetConstraintType()

◆ SetValue() [1/2]

◆ SetValue() [2/2]

◆ Transform()

Field Documentation

◆ _Private

◆ count_