This is the Region class. The region that designates areas of your model for special purposes, such as an area affected by a datum target. The region can contain a hatching and boundaries that are stored as geometries. More...
Public Types | |
enum | RegionType { RectangularType, CircularType, AnnularType, CylindricalType, ArbitraryType, UnknownType } |
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_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_ErrorStatus | GetAnnularInnerDiameter (Dtk_Double64 &outDiameter) |
Gets the inner diameter of the annular Dtk_Region. More... | |
Dtk_ErrorStatus | GetAnnularOuterDiameter (Dtk_Double64 &outDiameter) |
Gets the outer diameter of the annular Dtk_Region. More... | |
Dtk_ErrorStatus | GetCircularDiameter (Dtk_Double64 &outDiameter) |
Gets the diameter of the circular Dtk_Region. More... | |
Dtk_tab< Dtk_EntityPtr > | GetGeometries () const |
Retrieves the Dtk_Grid geometries. More... | |
Dtk_HatchingPattern | GetHatchingPattern () |
Gets Hatching Pattern of the region Dtk_Region. 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... | |
Dtk_ErrorStatus | GetRectangularHeight (Dtk_Double64 &outHeight) |
Gets the height of the rectangular Dtk_Region. More... | |
Dtk_ErrorStatus | GetRectangularWidth (Dtk_Double64 &outWidth) |
Gets the width of the rectangular Dtk_Region. 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 |
RegionType | GetType () |
Gets the type of the region. 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 |
Dtk_Region & | operator= (const Dtk_Region &inToBeAssigned) |
Assignment Operator. More... | |
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... | |
Dtk_ErrorStatus | SetAnnularInnerDiameter (Dtk_Double64 inDiameter) |
Sets the inner diameter of the annular Dtk_Region. More... | |
Dtk_ErrorStatus | SetAnnularOuterDiameter (Dtk_Double64 inDiameter) |
Sets the outer diameter of the annular Dtk_Region. More... | |
SetAsDeprecated ("Undefined", "Use Dtk_TextStyle::Justification()") Dtk_justication_type GetJustification() const | |
Get the justification type - read only -. More... | |
Dtk_ErrorStatus | SetCircularDiameter (Dtk_Double64 inDiameter) |
Sets the diameter of the circular Dtk_Region. 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... | |
Dtk_ErrorStatus | SetRectangularHeight (Dtk_Double64 inHeight) |
Sets the height of the rectangular Dtk_Region. More... | |
Dtk_ErrorStatus | SetRectangularWidth (Dtk_Double64 inWidth) |
Sets the width of the rectangular Dtk_Region. 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_RegionPtr | Create (RegionType inType, Dtk_HatchingPattern &inHatchingPattern, Dtk_tab< Dtk_EntityPtr > inGeometries) |
Copy Constructor. More... | |
static Dtk_Region * | 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_REGION } |
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_Region (const Dtk_Region &s) | |
Copy Constructor. More... | |
Dtk_Region (RegionType inType, Dtk_HatchingPattern &inHatchingPattern, Dtk_tab< Dtk_EntityPtr > inGeometries) | |
Base Constructor. More... | |
~Dtk_Region () | |
Destructor. More... | |
Protected Attributes | |
Dtk_Handle * | _Private |
unsigned long | count_ |
Friends | |
class | Dtk_SmartPtr< Dtk_Region > |
This is the Region class. The region that designates areas of your model for special purposes, such as an area affected by a datum target. The region can contain a hatching and boundaries that are stored as geometries.
Types of regions:
Here are different region types with their specificities
|
protected |
Base Constructor.
|
protected |
Copy Constructor.
|
protected |
Destructor.
|
protectedinherited |
|
protectedinherited |
|
protectedinherited |
|
protectedinherited |
|
protectedinherited |
|
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.
|
inherited |
Adds some additionnal geometries to the Dtk_2dEntity.
inAdditionnalGeometries | The geometries to be added |
|
inherited |
Adds an additionnal geometry to the Dtk_2dEntity.
inAdditionnalGeometry | The geometry to be added |
|
inherited |
Adds some additionnal texts to the Dtk_2dEntity.
inAddtionnalTexts | The texts to be added |
|
inherited |
Adds a leader to the Dtk_Annotation.
leader | The leader to be added |
|
protectedvirtual |
Implements Dtk_Annotation.
|
static |
Copy Constructor.
|
static |
Performs a dynamic cast - doesn't need RTTI -.
|
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.
|
virtualinherited |
|
inherited |
|
virtual |
Implements Dtk_Annotation.
|
inherited |
Retrieves the additionnal geometries of the Dtk_2dEntity.
|
inherited |
Retrieves the additionnal texts of the Dtk_2dEntity.
|
virtual |
Processes all the Dtk_Annotation anchor points.
outTabPnts | The resulting anchor point array. |
Implements Dtk_Annotation.
Dtk_ErrorStatus Dtk_Region::GetAnnularInnerDiameter | ( | Dtk_Double64 & | outDiameter | ) |
Gets the inner diameter of the annular Dtk_Region.
This is a semantic information (will not modify geometries)
outDiameter | The inner diameter |
Dtk_ErrorStatus Dtk_Region::GetAnnularOuterDiameter | ( | Dtk_Double64 & | outDiameter | ) |
Gets the outer diameter of the annular Dtk_Region.
This is a semantic information (will not modify geometries)
outDiameter | The outer diameter |
Dtk_ErrorStatus Dtk_Region::GetCircularDiameter | ( | Dtk_Double64 & | outDiameter | ) |
Gets the diameter of the circular Dtk_Region.
This is a semantic information (will not modify geometries)
outDiameter | The diameter |
Dtk_tab< Dtk_EntityPtr > Dtk_Region::GetGeometries | ( | ) | const |
Retrieves the Dtk_Grid geometries.
Dtk_HatchingPattern Dtk_Region::GetHatchingPattern | ( | ) |
Gets Hatching Pattern of the region Dtk_Region.
This is a semantic information (will not modify geometries)
|
inherited |
Get Internal UniqueID.
|
inherited |
Gets the i'th leader.
inPos | The leader position - 0 indexed - |
|
virtualinherited |
Get the annoation location point.
|
inherited |
Gets the location anchor type - read only -.
|
inherited |
Retrieves the number of leaders.
|
inherited |
Gets the annotation offset - read only -.
Dtk_ErrorStatus Dtk_Region::GetRectangularHeight | ( | Dtk_Double64 & | outHeight | ) |
Gets the height of the rectangular Dtk_Region.
This is a semantic information (will not modify geometries)
outWidth | The height |
Dtk_ErrorStatus Dtk_Region::GetRectangularWidth | ( | Dtk_Double64 & | outWidth | ) |
Gets the width of the rectangular Dtk_Region.
This is a semantic information (will not modify geometries)
outWidth | The width |
|
inherited |
Gets the text rotation angle giving a reference base.
inXAxis | The reference X Axis - default value = (1,0,0) - |
inYAxis | The reference Y Axis - default value = (0,1,0) - |
|
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.
RegionType Dtk_Region::GetType | ( | ) |
Gets the type of the region.
|
inherited |
Get the X Axis - read only -.
|
inherited |
Get the Y Axis - read only -.
|
inherited |
|
virtualinherited |
Dtk_Region& Dtk_Region::operator= | ( | const Dtk_Region & | inToBeAssigned | ) |
Assignment Operator.
inToBeAssigned | Object to copy. |
|
virtualinherited |
Reimplemented in Dtk_OffsetSurface.
|
virtualinherited |
Reverses the Dtk_Annotation.
Reimplemented in Dtk_DatumTarget.
|
virtual |
Sets the Dtk_Annotation anchor point.
inNewLocation | The new location point. |
inLocationAnchorType | The anchor type related to the new location. |
Implements Dtk_Annotation.
Dtk_ErrorStatus Dtk_Region::SetAnnularInnerDiameter | ( | Dtk_Double64 | inDiameter | ) |
Sets the inner diameter of the annular Dtk_Region.
This is a semantic information (will not modify geometries)
inDiameter | The inner diameter |
Dtk_ErrorStatus Dtk_Region::SetAnnularOuterDiameter | ( | Dtk_Double64 | inDiameter | ) |
Sets the outer diameter of the annular Dtk_Region.
This is a semantic information (will not modify geometries)
inDiameter | The outer diameter |
|
inherited |
Get the justification type - read only -.
Dtk_ErrorStatus Dtk_Region::SetCircularDiameter | ( | Dtk_Double64 | inDiameter | ) |
Sets the diameter of the circular Dtk_Region.
This is a semantic information (will not modify geometries)
inDiameter | The diameter |
|
virtual |
Sets the location point of the Dtk_Annotation.
The location point is related to the anchor type
inLocation | the location point |
Implements Dtk_Annotation.
|
inherited |
Sets the location point of the Dtk_Annotation.
The location point is related to the anchor type
location | the location point |
inAnchorType | The anchor type related to the new location. |
|
virtual |
Sets the offset of the Dtk_Annotation.
The Offset is used to process bounding frames.
inOffset | The offset |
Implements Dtk_Annotation.
Dtk_ErrorStatus Dtk_Region::SetRectangularHeight | ( | Dtk_Double64 | inHeight | ) |
Sets the height of the rectangular Dtk_Region.
This is a semantic information (will not modify geometries)
inWidth | The height |
Dtk_ErrorStatus Dtk_Region::SetRectangularWidth | ( | Dtk_Double64 | inWidth | ) |
Sets the width of the rectangular Dtk_Region.
This is a semantic information (will not modify geometries)
inWidth | The width |
|
virtualinherited |
Sets the annotation angle using the annotation base.
inRotationAngle | The rotation angle to be set |
Reimplemented in Dtk_Symbol, Dtk_GeometricalTolerance, Dtk_Table, Dtk_DatumTarget, Dtk_Welding, and Dtk_Roughness.
|
virtual |
Applies a transformation matrix to the entity. //!
inTransfo | The transformation matrix to apply. |
Implements Dtk_Annotation.
|
friend |
|
protected |
|
protectedinherited |