defines IGESViewsVisibleWithAttr, Type <402>, Form <4> in package IGESDraw More...

#include <IGESDraw_ViewsVisibleWithAttr.hxx>

Inheritance diagram for IGESDraw_ViewsVisibleWithAttr:

[legend]

Public Member Functions
	IGESDraw_ViewsVisibleWithAttr ()

void	Init (const Handle< IGESDraw_HArray1OfViewKindEntity > &allViewEntities, const Handle< TColStd_HArray1OfInteger > &allLineFonts, const Handle< IGESBasic_HArray1OfLineFontEntity > &allLineDefinitions, const Handle< TColStd_HArray1OfInteger > &allColorValues, const Handle< IGESGraph_HArray1OfColor > &allColorDefinitions, const Handle< TColStd_HArray1OfInteger > &allLineWeights, const Handle< IGESData_HArray1OfIGESEntity > &allDisplayEntities)
	This method is used to set fields of the class ViewsVisibleWithAttr.

void	InitImplied (const Handle< IGESData_HArray1OfIGESEntity > &allDisplayEntity)
	Changes only the list of Displayed Entities (Null allowed)

Standard_Boolean	IsSingle () const override
	Returns False (for a complex view)

Standard_Integer	NbViews () const override
	returns the number of Views containing the view visible, line font, color number, and line weight information

Standard_Integer	NbDisplayedEntities () const
	returns the number of entities which have this particular set of display characteristic, or zero if no Entities specified

Handle< IGESData_ViewKindEntity >	ViewItem (const Standard_Integer Index) const override
	returns the Index'th ViewKindEntity entity raises exception if Index <= 0 or Index > NbViews()

Standard_Integer	LineFontValue (const Standard_Integer Index) const
	returns the Index'th Line font value or zero raises exception if Index <= 0 or Index > NbViews()

Standard_Boolean	IsFontDefinition (const Standard_Integer Index) const
	returns True if the Index'th Line Font Definition is specified else returns False raises exception if Index <= 0 or Index > NbViews()

Handle< IGESData_LineFontEntity >	FontDefinition (const Standard_Integer Index) const
	returns the Index'th Line Font Definition Entity or NULL(0) raises exception if Index <= 0 or Index > NbViews()

Standard_Integer	ColorValue (const Standard_Integer Index) const
	returns the Index'th Color number value raises exception if Index <= 0 or Index > NbViews()

Standard_Boolean	IsColorDefinition (const Standard_Integer Index) const
	returns True if Index'th Color Definition is specified else returns False raises exception if Index <= 0 or Index > NbViews()

Handle< IGESGraph_Color >	ColorDefinition (const Standard_Integer Index) const
	returns the Index'th Color Definition Entity raises exception if Index <= 0 or Index > NbViews()

Standard_Integer	LineWeightItem (const Standard_Integer Index) const
	returns the Index'th Color Line Weight raises exception if Index <= 0 or Index > NbViews()

Handle< IGESData_IGESEntity >	DisplayedEntity (const Standard_Integer Index) const
	returns Index'th Display entity with this particular characteristics raises exception if Index <= 0 or Index > NbEntities()

Public Member Functions inherited from IGESData_ViewKindEntity
Public Member Functions inherited from IGESData_IGESEntity
IGESData_IGESType	IGESType () const
	gives IGES typing info (includes "Type" and "Form" data)

Standard_Integer	TypeNumber () const
	gives IGES Type Number (often coupled with Form Number)

Standard_Integer	FormNumber () const
	Returns the form number for that type of an IGES entity. The default form number is 0.

Handle< IGESData_IGESEntity >	DirFieldEntity (const Standard_Integer fieldnum) const
	Returns the Entity which has been recorded for a given Field Number, i.e. without any cast. Maps with : 3 : Structure 4 : LineFont 5 : LevelList 6 : View 7 : Transf(ormation Matrix) 8 : LabelDisplay 13 : Color. Other values give a null handle It can then be of any kind, while specific items have a Type.

Standard_Boolean	HasStructure () const
	returns True if an IGESEntity is defined with a Structure (it is normally reserved for certain classes, such as Macros)

Handle< IGESData_IGESEntity >	Structure () const
	Returns Structure (used by some types of IGES Entities only) Returns a Null Handle if Structure is not defined.

virtual IGESData_DefType	DefLineFont () const
	Returns the definition status of LineFont.

Standard_Integer	RankLineFont () const
	Returns LineFont definition as an Integer (if defined as Rank) If LineFont is defined as an Entity, returns a negative value.

Handle< IGESData_LineFontEntity >	LineFont () const
	Returns LineFont as an Entity (if defined as Reference) Returns a Null Handle if DefLineFont is not "DefReference".

virtual IGESData_DefList	DefLevel () const
	Returns the definition status of Level.

Standard_Integer	Level () const
	Returns the level the entity belongs to. Returns -1 if the entity belongs to more than one level.

Handle< IGESData_LevelListEntity >	LevelList () const
	Returns LevelList if Level is defined as a list. Returns a null handle if DefLevel is not DefSeveral.

virtual IGESData_DefList	DefView () const
	Returns the definition status of the view. This can be: none, one or several.

Handle< IGESData_ViewKindEntity >	View () const
	Returns the view of this IGES entity. This view can be a single view or a list of views. Warning A null handle is returned if the view is not defined.

Handle< IGESData_ViewKindEntity >	SingleView () const
	Returns the view as a single view if it was defined as such and not as a list of views. Warning A null handle is returned if DefView does not have the value DefOne.

Handle< IGESData_ViewKindEntity >	ViewList () const
	Returns the view of this IGES entity as a list. Warning A null handle is returned if the definition status does not have the value DefSeveral.

Standard_Boolean	HasTransf () const
	Returns True if a Transformation Matrix is defined.

Handle< IGESData_TransfEntity >	Transf () const
	Returns the Transformation Matrix (under IGES definition) Returns a Null Handle if there is none for a more complete use, see Location & CompoundLocation.

Standard_Boolean	HasLabelDisplay () const
	Returns True if a LabelDisplay mode is defined for this entity.

Handle< IGESData_LabelDisplayEntity >	LabelDisplay () const
	Returns the Label Display Associativity Entity if there is one. Returns a null handle if there is none.

Standard_Integer	BlankStatus () const
	gives Blank Status (0 visible, 1 blanked)

Standard_Integer	SubordinateStatus () const
	gives Subordinate Switch (0-1-2-3)

Standard_Integer	UseFlag () const
	gives Entity's Use Flag (0 to 5)

Standard_Integer	HierarchyStatus () const
	gives Hierarchy status (0-1-2)

Standard_Integer	LineWeightNumber () const
	Returns the LineWeight Number (0 not defined), see also LineWeight.

Standard_Real	LineWeight () const
	Returns the true Line Weight, computed from LineWeightNumber and Global Parameter in the Model by call to SetLineWeight.

virtual IGESData_DefType	DefColor () const
	Returns the definition status of Color.

Standard_Integer	RankColor () const
	Returns the color definition as an integer value if the color was defined as a rank. Warning A negative value is returned if the color was defined as an entity.

Handle< IGESData_ColorEntity >	Color () const
	Returns the IGES entity which describes the color of the entity. Returns a null handle if this entity was defined as an integer.

Standard_Boolean	CResValues (const Standard_CString res1, const Standard_CString res2) const
	returns "reserved" alphanumeric values res1 and res2 res1 and res2 have to be reserved as Character[9 at least] (remark : their content is changed) returned values are ended by null character in 9th returned Boolean is False if res1 and res2 are blank, true else

Standard_Boolean	HasShortLabel () const
	Returns true if a short label is defined. A short label is a non-blank 8-character string.

Handle< TCollection_HAsciiString >	ShortLabel () const
	Returns the label value for this IGES entity as a string. Warning If the label is blank, this string is null.

virtual Standard_Boolean	HasSubScriptNumber () const
	Returns true if a subscript number is defined. A subscript number is an integer used to identify a label.

Standard_Integer	SubScriptNumber () const
	Returns the integer subscript number used to identify this IGES entity. Warning 0 is returned if no subscript number is defined for this IGES entity.

void	InitDirFieldEntity (const Standard_Integer fieldnum, const Handle< IGESData_IGESEntity > &ent)
	Initializes a directory field as an Entiy of any kind See DirFieldEntity for more details.

void	InitTransf (const Handle< IGESData_TransfEntity > &ent)
	Initializes Transf, or erases it if <ent> is given Null.

void	InitView (const Handle< IGESData_ViewKindEntity > &ent)
	Initializes View, or erases it if <ent> is given Null.

void	InitLineFont (const Handle< IGESData_LineFontEntity > &ent, const Standard_Integer rank=0)
	Initializes LineFont : if <ent> is not Null, it gives LineFont, else <rank> gives or erases (if zero) RankLineFont.

void	InitLevel (const Handle< IGESData_LevelListEntity > &ent, const Standard_Integer val=0)
	Initializes Level : if <ent> is not Null, it gives LevelList, else <val> gives or erases (if zero) unique Level.

void	InitColor (const Handle< IGESData_ColorEntity > &ent, const Standard_Integer rank=0)
	Initializes Color data : if <ent> is not Null, it gives Color, else <rank> gives or erases (if zero) RankColor.

void	InitStatus (const Standard_Integer blank, const Standard_Integer subordinate, const Standard_Integer useflag, const Standard_Integer hierarchy)
	Initializes the Status of Directory Part.

void	SetLabel (const Handle< TCollection_HAsciiString > &label, const Standard_Integer sub=-1)
	Sets a new Label to an IGES Entity If _{is given, it sets value of SubScriptNumber else, SubScriptNumber is erased.}

void	InitMisc (const Handle< IGESData_IGESEntity > &str, const Handle< IGESData_LabelDisplayEntity > &lab, const Standard_Integer weightnum)
	Initializes various data (those not yet seen above), or erases them if they are given as Null (Zero for <weightnum>) : <str> for Structure, <lab> for LabelDisplay, and <weightnum> for WeightNumber.

Standard_Boolean	HasOneParent () const
	Returns True if an entity has one and only one parent, defined by a SingleParentEntity Type Associativity (explicit sharing). Thus, implicit sharing remains defined at model level (see class ToolLocation)

Handle< IGESData_IGESEntity >	UniqueParent () const
	Returns the Unique Parent (in the sense given by HasOneParent) Error if there is none or several.

gp_GTrsf	Location () const
	Returns Location given by Transf in Directory Part (see above) It must be considered for local definition : if the Entity is set in a "Parent", that one can add its one Location, but this is not taken in account here : see CompoundLocation for that. If no Transf is defined, returns Identity If Transf is itself compound, gives the final result.

gp_GTrsf	VectorLocation () const
	Returns Location considered for Vectors, i.e. without its Translation Part. As Location, it gives local definition.

gp_GTrsf	CompoundLocation () const
	Returns Location by taking in account a Parent which has its own Location : that one will be combined to that of <me> The Parent is considered only if HasOneParent is True, else it is ignored and CompoundLocation = Location.

Standard_Boolean	HasName () const
	says if a Name is defined, as Short Label or as Name Property (Property is looked first, else ShortLabel is considered)

Handle< TCollection_HAsciiString >	NameValue () const
	returns Name value as a String (Property Name or ShortLabel) if SubNumber is defined, it is concatenated after ShortLabel as follows label(number). Ignored with a Property Name

Standard_Boolean	ArePresentAssociativities () const
	Returns True if the Entity is defined with an Associativity list, even empty (that is, file contains its length 0) Else, the file contained NO idencation at all about this list.

Standard_Integer	NbAssociativities () const
	gives number of recorded associativities (0 no list defined)

Interface_EntityIterator	Associativities () const
	Returns the Associativity List under the form of an EntityIterator.

Standard_Integer	NbTypedAssociativities (const Handle< Standard_Type > &atype) const
	gives how many Associativities have a given type

Handle< IGESData_IGESEntity >	TypedAssociativity (const Handle< Standard_Type > &atype) const
	returns the Associativity of a given Type (if only one exists) Error if none or more than one

void	Associate (const Handle< IGESData_IGESEntity > &ent) const
	Sets "me" in the Associativity list of another Entity.

void	Dissociate (const Handle< IGESData_IGESEntity > &ent) const
	Resets "me" from the Associativity list of another Entity.

Standard_Boolean	ArePresentProperties () const
	Returns True if the Entity is defined with a Property list, even empty (that is, file contains its length 0) Else, the file contained NO idencation at all about this list.

Standard_Integer	NbProperties () const
	Gives number of recorded properties (0 no list defined)

Interface_EntityIterator	Properties () const
	Returns Property List under the form of an EntityIterator.

Standard_Integer	NbTypedProperties (const Handle< Standard_Type > &atype) const
	gives how many Properties have a given type

Handle< IGESData_IGESEntity >	TypedProperty (const Handle< Standard_Type > &atype, const Standard_Integer anum=0) const
	returns the Property of a given Type Error if none or more than one

void	AddProperty (const Handle< IGESData_IGESEntity > &ent)
	Adds a Property in the list.

void	RemoveProperty (const Handle< IGESData_IGESEntity > &ent)
	Removes a Property from the list.

void	SetLineWeight (const Standard_Real defw, const Standard_Real maxw, const Standard_Integer gradw)
	computes and sets "true" line weight according IGES rules from global data MaxLineWeight (maxv) and LineWeightGrad (gradw), or sets it to defw (Default) if LineWeightNumber is null

Public Member Functions inherited from Standard_Transient
	Standard_Transient ()
	Empty constructor.

	Standard_Transient (const Standard_Transient &)
	Copy constructor – does nothing.

Standard_Transient &	operator= (const Standard_Transient &)
	Assignment operator, needed to avoid copying reference counter.

virtual	~Standard_Transient ()
	Destructor must be virtual.

virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.

Standard_Boolean	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.

Standard_Boolean	IsInstance (const Standard_CString theTypeName) const
	Returns a true value if this is an instance of TypeName.

Standard_Boolean	IsKind (const opencascade::handle< Standard_Type > &theType) const
	Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism.

Standard_Boolean	IsKind (const Standard_CString theTypeName) const
	Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism.

Standard_Transient *	This () const
	Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero.

Standard_Integer	GetRefCount () const noexcept
	Get the reference counter of this object.

void	IncrementRefCounter () noexcept
	Increments the reference counter of this object.

Standard_Integer	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value.

virtual void	Delete () const
	Memory deallocator for transient classes.

Additional Inherited Members
Public Types inherited from Standard_Transient
typedef void	base_type
	Returns a type descriptor about this object.

Static Public Member Functions inherited from Standard_Transient
static constexpr const char *	get_type_name ()
	Returns a type descriptor about this object.

static const opencascade::handle< Standard_Type > &	get_type_descriptor ()
	Returns type descriptor of Standard_Transient class.

Protected Member Functions inherited from IGESData_IGESEntity
	IGESData_IGESEntity ()
	prepares lists of optional data, set values to defaults

void	InitTypeAndForm (const Standard_Integer typenum, const Standard_Integer formnum)
	Initializes Type and Form Numbers to new values. Reserved for special uses.

void	LoadAssociativities (const Interface_EntityList &list)
	Loads a complete, already loaded, List of Asociativities (used during Read or Copy Operations)

void	LoadProperties (const Interface_EntityList &list)
	Loads a complete, already loaded, List of Properties (used during Read or Copy Operations)

void	ClearProperties ()
	Removes all properties in once.

Detailed Description

defines IGESViewsVisibleWithAttr, Type <402>, Form <4> in package IGESDraw

This class is extension of Class ViewsVisible. It is used for those entities that are visible in multiple views, but must have a different line font, color number, or line weight in each view.

Constructor & Destructor Documentation

◆ IGESDraw_ViewsVisibleWithAttr()

IGESDraw_ViewsVisibleWithAttr::IGESDraw_ViewsVisibleWithAttr ( )

Member Function Documentation

◆ ColorDefinition()

Handle< IGESGraph_Color > IGESDraw_ViewsVisibleWithAttr::ColorDefinition ( const Standard_Integer Index ) const

returns the Index'th Color Definition Entity raises exception if Index <= 0 or Index > NbViews()

◆ ColorValue()

Standard_Integer IGESDraw_ViewsVisibleWithAttr::ColorValue ( const Standard_Integer Index ) const

returns the Index'th Color number value raises exception if Index <= 0 or Index > NbViews()

◆ DisplayedEntity()

Handle< IGESData_IGESEntity > IGESDraw_ViewsVisibleWithAttr::DisplayedEntity ( const Standard_Integer Index ) const

returns Index'th Display entity with this particular characteristics raises exception if Index <= 0 or Index > NbEntities()

◆ FontDefinition()

Handle< IGESData_LineFontEntity > IGESDraw_ViewsVisibleWithAttr::FontDefinition ( const Standard_Integer Index ) const

returns the Index'th Line Font Definition Entity or NULL(0) raises exception if Index <= 0 or Index > NbViews()

◆ Init()

void IGESDraw_ViewsVisibleWithAttr::Init	(	const Handle< IGESDraw_HArray1OfViewKindEntity > &	allViewEntities,
		const Handle< TColStd_HArray1OfInteger > &	allLineFonts,
		const Handle< IGESBasic_HArray1OfLineFontEntity > &	allLineDefinitions,
		const Handle< TColStd_HArray1OfInteger > &	allColorValues,
		const Handle< IGESGraph_HArray1OfColor > &	allColorDefinitions,
		const Handle< TColStd_HArray1OfInteger > &	allLineWeights,
		const Handle< IGESData_HArray1OfIGESEntity > &	allDisplayEntities )

This method is used to set fields of the class ViewsVisibleWithAttr.

allViewEntities : All View kind entities
allLineFonts : All Line Font values or zero(0)
allLineDefinitions : Line Font Definition (if Line Font value = 0)
allColorValues : All Color values
allColorDefinitions : All Color Definition Entities
allLineWeights : All Line Weight values
allDisplayEntities : Entities which are member of this associativity raises exception if Lengths of allViewEntities, allLineFonts, allColorValues,allColorDefinitions, allLineWeights are not same

◆ InitImplied()

void IGESDraw_ViewsVisibleWithAttr::InitImplied ( const Handle< IGESData_HArray1OfIGESEntity > & allDisplayEntity )

Changes only the list of Displayed Entities (Null allowed)

◆ IsColorDefinition()

Standard_Boolean IGESDraw_ViewsVisibleWithAttr::IsColorDefinition ( const Standard_Integer Index ) const

returns True if Index'th Color Definition is specified else returns False raises exception if Index <= 0 or Index > NbViews()

◆ IsFontDefinition()

Standard_Boolean IGESDraw_ViewsVisibleWithAttr::IsFontDefinition ( const Standard_Integer Index ) const

returns True if the Index'th Line Font Definition is specified else returns False raises exception if Index <= 0 or Index > NbViews()

◆ IsSingle()

Standard_Boolean IGESDraw_ViewsVisibleWithAttr::IsSingle ( ) const

overridevirtual

Returns False (for a complex view)

Implements IGESData_ViewKindEntity.

◆ LineFontValue()

Standard_Integer IGESDraw_ViewsVisibleWithAttr::LineFontValue ( const Standard_Integer Index ) const

returns the Index'th Line font value or zero raises exception if Index <= 0 or Index > NbViews()

◆ LineWeightItem()

Standard_Integer IGESDraw_ViewsVisibleWithAttr::LineWeightItem ( const Standard_Integer Index ) const

returns the Index'th Color Line Weight raises exception if Index <= 0 or Index > NbViews()

◆ NbDisplayedEntities()

Standard_Integer IGESDraw_ViewsVisibleWithAttr::NbDisplayedEntities ( ) const

returns the number of entities which have this particular set of display characteristic, or zero if no Entities specified

◆ NbViews()

Standard_Integer IGESDraw_ViewsVisibleWithAttr::NbViews ( ) const

overridevirtual

returns the number of Views containing the view visible, line font, color number, and line weight information

Implements IGESData_ViewKindEntity.

◆ ViewItem()

Handle< IGESData_ViewKindEntity > IGESDraw_ViewsVisibleWithAttr::ViewItem ( const Standard_Integer Index ) const

overridevirtual

returns the Index'th ViewKindEntity entity raises exception if Index <= 0 or Index > NbViews()

Implements IGESData_ViewKindEntity.

The documentation for this class was generated from the following file:

IGESDraw_ViewsVisibleWithAttr.hxx

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ IGESDraw_ViewsVisibleWithAttr()

Member Function Documentation

◆ ColorDefinition()

◆ ColorValue()

◆ DisplayedEntity()

◆ FontDefinition()

◆ Init()

◆ InitImplied()

◆ IsColorDefinition()

◆ IsFontDefinition()

◆ IsSingle()

◆ LineFontValue()

◆ LineWeightItem()

◆ NbDisplayedEntities()

◆ NbViews()

◆ ViewItem()