class BinMNaming_NamedShapeDriver;
DEFINE_STANDARD_HANDLE(BinMNaming_NamedShapeDriver, BinMDF_ADriver)
-//! NamedShape Attribute Driver.
+//! NamedShape Attribute Driver.
class BinMNaming_NamedShapeDriver : public BinMDF_ADriver
{
class BinMNaming_NamingDriver;
DEFINE_STANDARD_HANDLE(BinMNaming_NamingDriver, BinMDF_ADriver)
-//! Naming Attribute Driver.
+//! Naming Attribute Driver.
class BinMNaming_NamingDriver : public BinMDF_ADriver
{
DEFINE_STANDARD_HANDLE(TDataXtd_Plane, TDataStd_GenericEmpty)
//! The basis to define a plane attribute.
-//! Warning: Use TDataXtd_Geometry attribute to retrieve the
+//! Warning: Use TDataXtd_Geometry attribute to retrieve the
//! gp_Pln of the Plane attribute
class TDataXtd_Plane : public TDataStd_GenericEmpty
{
//! NamedShape at the given label, which contains the
//! argument selected shape. When calling this
//! method, the sub-hierarchy of <label> is first cleared,
-//! then a TNaming_NamedShape is ALWAYS created at
+//! then a TNaming_NamedShape is ALWAYS created at
//! this <label>, with the TNaming_SELECTED evolution.
//! The <Naming attribute> is associated to the selected
//! shape which store the arguments of the selection.
const Handle(TNaming_UsedShapes)& US);
//! Returns the label of the first apparition of
- //! <aShape>. Transdef is a value of the transaction
+ //! <aShape>. Transdef is a value of the transaction
//! of the first apparition of <aShape>.
Standard_EXPORT static TDF_Label Label(const Handle(TNaming_UsedShapes)& Shapes,
const TopoDS_Shape& aShape,
//! has not yet been retrieved, this method will retrieve it.
Standard_EXPORT Handle(CDM_Document) Document(const Standard_Integer aReferenceIdentifier) const;
- //! returns True if the To Document of the reference
+ //! returns True if the To Document of the reference
//! identified by aReferenceIdentifier is in session, False
//! if it corresponds to a not yet retrieved document.
Standard_EXPORT Standard_Boolean IsInSession(const Standard_Integer aReferenceIdentifier) const;
//! Copies a reference to this document. This method
//! avoid retrieval of referenced document. The arguments
//! are the original document and a valid reference
- //! identifier Returns the local identifier.
+ //! identifier Returns the local identifier.
Standard_EXPORT Standard_Integer CopyReference(const Handle(CDM_Document)& aFromDocument,
const Standard_Integer aReferenceIdentifier);
//! The second method should be redefined to put
//! additional document that could be used by the
//! retrieval instead of the principal document, depending
-//! on the schema used during the retrieval. For example,
-//! a second document could be a standard
+//! on the schema used during the retrieval.
+//! For example, a second document could be a standard
//! CDMShape_Document. This means that a client
//! application will already be able to extract a CDMShape_Document
//! of the file, if the Shape Schema remains unchanged.
//! Backup() method.
Standard_Boolean IsBackuped() const;
- //! Copies the attribute contents into a new other
+ //! Copies the attribute contents into a new other
//! attribute. It is used by Backup().
Standard_EXPORT virtual Handle(TDF_Attribute) BackupCopy() const;
//! iteration process.
Standard_Boolean More() const;
- //! Move the current iteration to the next Item.
+ //! Move the current iteration to the next Item.
Standard_EXPORT void Next();
//! Moves this iteration to the next brother
const Standard_Boolean append = Standard_True) const;
//! Forgets an Attribute from the current label,
- //! setting its forgotten status true and its valid
+ //! setting its forgotten status true and its valid
//! status false. Raises if the attribute is not in
//! the structure.
Standard_EXPORT void ForgetAttribute(const Handle(TDF_Attribute)& anAttribute) const;
Standard_EXPORT void Init(const Standard_Integer lower, const Standard_Integer upper);
//! Sets the <Index>th element of the array to <Value>
- //! OutOfRange exception is raised if <Index> doesn't respect Lower and Upper bounds of the
- //! internal array.
+ //! OutOfRange exception is raised if <Index> doesn't respect Lower and Upper bounds
+ //! of the internal array.
Standard_EXPORT void SetValue(const Standard_Integer Index, const Standard_Integer Value);
//! Sets the explicit GUID (user defined) for the attribute.
const Standard_Boolean isExported = Standard_False);
//! Tool to Create an Real attribute from <value>, Insert
- //! it in a new son label of <me>. The Integer attribute
+ //! it in a new son label of <me>. The Integer attribute
//! is returned.
Standard_EXPORT Handle(TDataStd_Integer) Append(
const Standard_Integer value,
{
public:
- //! class methods working on the node
- //! ===================================
+ //! class methods working on the node
+ //! =================================
//! Returns true if the tree node T is found on the label L.
//! Otherwise, false is returned.
Standard_EXPORT static Standard_Boolean Find(const TDF_Label& L, Handle(TDataStd_TreeNode)& T);
Standard_EXPORT Standard_Boolean IsAssigned() const;
//! create(if doesn't exist) and returns the assigned
- //! expression attribute. fill it after.
+ //! expression attribute. fill it after.
Standard_EXPORT Handle(TDataStd_Expression) Assign() const;
//! if <me> is assigned delete the associated expression
Standard_EXPORT void Unit(const TCollection_AsciiString& unit);
//! to read/write fields
- //! ===================
+ //! ====================
Standard_EXPORT const TCollection_AsciiString& Unit() const;
//! if <status> is True, this variable will not be
//! can be used.
Standard_EXPORT Standard_Integer GetAvailableUndos() const;
- //! Will UNDO one step, returns False if no undo was
+ //! Will UNDO one step, returns False if no undo was
//! done (Undos == 0).
//! Otherwise, true is returned and one step in the
//! list of undoes is undone.
//! can be used.
Standard_EXPORT Standard_Integer GetAvailableRedos() const;
- //! Will REDO one step, returns False if no redo was
+ //! Will REDO one step, returns False if no redo was
//! done (Redos == 0).
//! Otherwise, true is returned, and one step in the list of redoes is done again.
Standard_EXPORT Standard_Boolean Redo();
Standard_EXPORT Standard_Real FinishDiaSize() const;
//! Returns Plating Status :
- //! False = not plating / True = is plating
+ //! False = not plating / True = is plating
Standard_EXPORT Standard_Boolean IsPlating() const;
//! returns the lower numbered layer
Standard_EXPORT Standard_Real WidthOfMetalization() const;
//! returns the cornering code
- //! 0 = Rounded / 1 = Squared
+ //! 0 = Rounded / 1 = Squared
Standard_EXPORT Standard_Integer CorneringCode() const;
//! returns the extension flag
Standard_EXPORT virtual IGESData_DefList DefLevel() const;
//! Returns the level the entity
- //! belongs to. Returns -1 if the entity belongs to more than one level.
+ //! belongs to. Returns -1 if the entity belongs to more than one level.
Standard_EXPORT Standard_Integer Level() const;
//! Returns LevelList if Level is
//! defines IGES Ordinate Dimension, Type <218> Form <0, 1>,
//! in package IGESDimen
-//! Note : The ordinate dimension entity is used to
+//! Note: The ordinate dimension entity is used to
//! indicate dimensions from a common base line.
//! Dimensioning is only permitted along the XT
//! or YT axis.
//! returns the Index'th IGESEntity in subfigure exclusive of primary
//! reference designator and Control Points
- //! raises exception if Index <=0 or Index > NbEntities()
+ //! raises exception if Index <=0 or Index > NbEntities()
Standard_EXPORT Handle(IGESData_IGESEntity) Entity(const Standard_Integer Index) const;
//! return value = 0 : Not Specified
//! returns 0 if all replicated entities to be displayed
Standard_EXPORT Standard_Integer ListCount() const;
- //! returns 0 if half or fewer of the elements of the array are defined
+ //! returns 0 if half or fewer of the elements of the array are defined
//! 1 if half or more of the elements are defined
Standard_EXPORT Standard_Boolean DoDontFlag() const;
//! Returns a category number which characterizes an entity
//! Shape for all, but Drawing for :
- //! Flash; Point with a symbol; Plane with a symbol
+ //! Flash; Point with a symbol; Plane with a symbol
Standard_EXPORT virtual Standard_Integer CategoryNumber(const Standard_Integer CN,
const Handle(Standard_Transient)& ent,
const Interface_ShareTool& shares) const
//! polynomial segments. The curve could be of the type
//! Linear, Quadratic, Cubic, Wilson-Fowler, Modified
//! Wilson-Fowler, B-Spline. The N polynomial segments
-//! are delimited by the break points T(1), T(2), T(3),
-//! ..., T(N+1).
+//! are delimited by the break points:
+//! T(1), T(2), T(3), ..., T(N+1).
class IGESGeom_SplineCurve : public IGESData_IGESEntity
{
//! defines IGESTrimmedSurface, Type <144> Form <0>
//! in package IGESGeom
-//! A simple closed curve in Euclidean plane divides the
+//! A simple closed curve in Euclidean plane divides the
//! plane in to two disjoint, open connected components; one
//! bounded, one unbounded. The bounded one is called the
//! interior region to the curve. Unbounded component is called
Standard_EXPORT Standard_Integer NbPropertyValues() const;
//! returns False if <me> is an infinite grid,
- //! True if <me> is a finite grid.
+ //! True if <me> is a finite grid.
Standard_EXPORT Standard_Boolean IsFinite() const;
//! returns False if <me> is a Point grid,
- //! True if <me> is a Line grid.
+ //! True if <me> is a Line grid.
Standard_EXPORT Standard_Boolean IsLine() const;
//! returns False if <me> is a Weighted grid,
- //! True if <me> is not a Weighted grid.
+ //! True if <me> is not a Weighted grid.
Standard_EXPORT Standard_Boolean IsWeighted() const;
//! returns coordinates of lower left corner,
Standard_EXPORT Standard_Integer NbVoidShells() const;
//! returns Index'th void shell.
- //! raises exception if Index <= 0 or Index > NbVoidShells()
+ //! raises exception if Index <= 0 or Index > NbVoidShells()
Standard_EXPORT Handle(IGESSolid_Shell) VoidShell(const Standard_Integer Index) const;
//! returns Index'th orientation flag.
- //! raises exception if Index <= 0 or Index > NbVoidShells()
+ //! raises exception if Index <= 0 or Index > NbVoidShells()
Standard_EXPORT Standard_Boolean VoidOrientationFlag(const Standard_Integer Index) const;
DEFINE_STANDARD_RTTIEXT(IGESSolid_ManifoldSolid, IGESData_IGESEntity)
Standard_EXPORT Standard_Integer NbVertices() const;
//! returns the num'th vertex in the list
- //! raises exception if num <= 0 or num > NbVertices()
+ //! raises exception if num <= 0 or num > NbVertices()
Standard_EXPORT gp_Pnt Vertex(const Standard_Integer num) const;
DEFINE_STANDARD_RTTIEXT(IGESSolid_VertexList, IGESData_IGESEntity)
//! Creates a tool BasicSurface ready to run, with
//! epsilons set to 1.E-04, TheModeTopo to True, the
- //! optimization of the continuity to False.
+ //! optimization of the continuity to False.
Standard_EXPORT IGESToBRep_BasicSurface();
//! Creates a tool BasicSurface ready to run and sets its
Handle(Transfer_TransientProcess) GetTransferProcess() const;
//! Returns the result of the transfert of any IGES Curve
- //! or Surface Entity. If the transfer has failed, this
+ //! or Surface Entity. If the transfer has failed, this
//! member return a NullEntity.
Standard_EXPORT TopoDS_Shape
TransferCurveAndSurface(const Handle(IGESData_IGESEntity)& start,
const Message_ProgressRange& theProgress = Message_ProgressRange());
//! Returns the result of the transfert the geometry of
- //! any IGESEntity. If the transfer has failed, this
+ //! any IGESEntity. If the transfer has failed, this
//! member return a NullEntity.
Standard_EXPORT TopoDS_Shape
TransferGeometry(const Handle(IGESData_IGESEntity)& start,
const TopoDS_Shape& result);
//! Returns the number of shapes results contained in "myMap" for the
- //! IGESEntity start ( type VertexList or EdgeList).
+ //! IGESEntity start (type VertexList or EdgeList).
Standard_EXPORT Standard_Integer NbShapeResult(const Handle(IGESData_IGESEntity)& start) const;
//! Returns the numth result of the IGESEntity start (type VertexList or
const Standard_Integer num) const;
//! set in "myMap" the result of the transfer of the entity of the
- //! IGESEntity start ( type VertexList or EdgeList).
+ //! IGESEntity start (type VertexList or EdgeList).
Standard_EXPORT void AddShapeResult(const Handle(IGESData_IGESEntity)& start,
const TopoDS_Shape& result);
const;
//! Computes the length, plane angle and solid angle conversion
- //! factor . Returns a status, 0 if OK
+ //! factor. Returns a status, 0 if OK
Standard_EXPORT Standard_Integer
ComputeFactors(const Handle(StepRepr_GlobalUnitAssignedContext)& aContext,
const StepData_Factors& theLocalFactors = StepData_Factors());
const StepData_Factors& theLocalFactors = StepData_Factors(),
const Message_ProgressRange& theProgress = Message_ProgressRange());
- //! Transfers shape representation relationship entity
+ //! Transfers shape representation relationship entity
//! theUseTrsf - special flag for using Axis2Placement from ShapeRepresentation for transform root
//! shape
Standard_EXPORT Handle(TransferBRep_ShapeBinder) TransferEntity(
const Standard_Boolean theUseTrsf = Standard_False,
const Message_ProgressRange& theProgress = Message_ProgressRange());
- //! Transfers geometric representation item entity such as ManifoldSolidBRep ,...etc
+ //! Transfers geometric representation item entity such as ManifoldSolidBRep ,...etc
Standard_EXPORT Handle(TransferBRep_ShapeBinder) TransferEntity(
const Handle(StepGeom_GeometricRepresentationItem)& git,
const Handle(Transfer_TransientProcess)& TP,
const Standard_Boolean isManifold,
const Message_ProgressRange& theProgress);
- //! Transfers mapped item
+ //! Transfers mapped item
Standard_EXPORT Handle(TransferBRep_ShapeBinder) TransferEntity(
const Handle(StepRepr_MappedItem)& mapit,
const Handle(Transfer_TransientProcess)& TP,
const StepData_Factors& theLocalFactors,
const Message_ProgressRange& theProgress);
- //! Transfers FaceSurface entity
+ //! Transfers FaceSurface entity
Standard_EXPORT Handle(TransferBRep_ShapeBinder) TransferEntity(
const Handle(StepShape_FaceSurface)& fs,
const Handle(Transfer_TransientProcess)& TP,
const StepData_Factors& theLocalFactors,
const Message_ProgressRange& theProgress);
- //! Translates file by old way when CDSR are roots . Acts only if "read.step.product_mode" is
- //! equal Off.
+ //! Translates file by old way when CDSR are roots.
+ //! Acts only if "read.step.product_mode" is equal Off.
Standard_EXPORT Handle(TransferBRep_ShapeBinder) OldWay(
const Handle(Standard_Transient)& start,
const Handle(Transfer_TransientProcess)& TP,
//! For the translation of iges files it is possible to use next sequence:
//! To change translation parameters
//! class Interface_Static should be used before beginning of
-//! translation (see STEP Parameters and General Parameters)
+//! translation (see STEP Parameters and General Parameters)
//! Creation of reader - STEPControl_Reader reader;
//! To load s file in a model use method reader.ReadFile("filename.stp")
//! To print load results reader.PrintCheckLoad(failsonly,mode)
Standard_OVERRIDE;
private:
- //! Returns units for length , angle and solidangle for shape representations
+ //! Returns units for length, angle and solidangle for shape representations
Standard_EXPORT Standard_Boolean
findUnits(const Handle(StepRepr_RepresentationContext)& theReprContext,
TColStd_Array1OfAsciiString& theNameUnits,
//! 0 else
Standard_EXPORT virtual Standard_Integer CaseNum(const Handle(Standard_Transient)& ent) const;
- //! returns Value as a GeometricRepresentationItem (Null if another type)
+ //! returns Value as a GeometricRepresentationItem (Null if another type)
Standard_EXPORT virtual Handle(StepGeom_GeometricRepresentationItem) GeometricRepresentationItem()
const;
- //! returns Value as a GroupRelationship (Null if another type)
+ //! returns Value as a GroupRelationship (Null if another type)
Standard_EXPORT virtual Handle(StepBasic_GroupRelationship) GroupRelationship() const;
- //! returns Value as a MappedItem (Null if another type)
+ //! returns Value as a MappedItem (Null if another type)
Standard_EXPORT virtual Handle(StepRepr_MappedItem) MappedItem() const;
- //! returns Value as a ProductDefinition (Null if another type)
+ //! returns Value as a ProductDefinition (Null if another type)
Standard_EXPORT virtual Handle(StepBasic_ProductDefinition) ProductDefinition() const;
- //! returns Value as a ProductDefinitionFormation (Null if another type)
+ //! returns Value as a ProductDefinitionFormation (Null if another type)
Standard_EXPORT virtual Handle(StepBasic_ProductDefinitionFormation) ProductDefinitionFormation()
const;
- //! returns Value as a PropertyDefinitionRepresentation (Null if another type)
+ //! returns Value as a PropertyDefinitionRepresentation (Null if another type)
Standard_EXPORT virtual Handle(StepRepr_PropertyDefinitionRepresentation)
PropertyDefinitionRepresentation() const;
- //! returns Value as a Representation (Null if another type)
+ //! returns Value as a Representation (Null if another type)
Standard_EXPORT virtual Handle(StepRepr_Representation) Representation() const;
- //! returns Value as a RepresentationItem (Null if another type)
+ //! returns Value as a RepresentationItem (Null if another type)
Standard_EXPORT virtual Handle(StepRepr_RepresentationItem) RepresentationItem() const;
- //! returns Value as a RepresentationRelationshipWithTransformation (Null if another type)
+ //! returns Value as a RepresentationRelationshipWithTransformation (Null if another type)
Standard_EXPORT virtual Handle(StepRepr_RepresentationRelationshipWithTransformation)
RepresentationRelationshipWithTransformation() const;
- //! returns Value as a ShapeAspect (Null if another type)
+ //! returns Value as a ShapeAspect (Null if another type)
Standard_EXPORT virtual Handle(StepRepr_ShapeAspect) ShapeAspect() const;
- //! returns Value as a ShapeAspectRelationship (Null if another type)
+ //! returns Value as a ShapeAspectRelationship (Null if another type)
Standard_EXPORT virtual Handle(StepRepr_ShapeAspectRelationship) ShapeAspectRelationship() const;
- //! returns Value as a ShapeRepresentationRelationship (Null if another type)
+ //! returns Value as a ShapeRepresentationRelationship (Null if another type)
Standard_EXPORT virtual Handle(StepRepr_ShapeRepresentationRelationship)
ShapeRepresentationRelationship() const;
- //! returns Value as a StyledItem (Null if another type)
+ //! returns Value as a StyledItem (Null if another type)
Standard_EXPORT virtual Handle(StepVisual_StyledItem) StyledItem() const;
- //! returns Value as a TopologicalRepresentationItem (Null if another type)
+ //! returns Value as a TopologicalRepresentationItem (Null if another type)
Standard_EXPORT virtual Handle(StepShape_TopologicalRepresentationItem)
TopologicalRepresentationItem() const;
Standard_EXPORT void SetType(const Handle(Standard_Type)& atype);
//! Sets <me> for a Described Entity, whose Description must match
- //! the type name <dscnam>
+ //! the type name <dscnam>
Standard_EXPORT void SetDescr(const Standard_CString dscnam);
//! Adds an arity count to <me>, by default 1
//! Returns True if the Type of an Entity complies with the
//! definition list of the SelectType.
//! Also checks for a SelectMember
- //! Default Implementation looks for CaseNum or CaseMem positive
+ //! Default Implementation looks for CaseNum or CaseMem positive
Standard_EXPORT Standard_Boolean Matches(const Handle(Standard_Transient)& ent) const;
//! Stores an Entity. This allows to define a specific SelectType
//! Now current record has ident, but args and types are empty.
//! 4. Flex rule detected "ADVANCED_FACE" call CreateNewText and send a token "TYPE".
//! Now class contains "ADVANCED_FACE", as current text value.
-//! 5. Bison receive a token and call RecordType (), it
+//! 5. Bison receive a token and call RecordType (), it
//! set "ADVANCED_FACE" to the current record as a type.
//! Now current record has ident and type, but args are empty.
//! 6. Flex rule detected "(" send token "(".
//! Now class continues to contain "ADVANCED_FACE", as current text value.
-//! 7. Bison receive a token and call RecordListStart (),
+//! 7. Bison receive a token and call RecordListStart (),
//! it does nothing via the current state.
//! Now current record is not update.
//! 8. Flex rule detected ('') call CreateNewText and SetTypeArg and
//! send token TEXT.
//! Now class contains empty current text value.
-//! 9. Bison receive a token and call CreateNewArg (), it
+//! 9. Bison receive a token and call CreateNewArg (), it
//! creates a new argument with empty text value and 'Text' type.
//! Now current record has ident, type and one argument.
//! 10. Flex rule detected "," call PrepareNewArg(",",1), it
//! Bison does nothing and the current text value and record are not updated.
//! 11. Flex rule detected "(" send token "(".
//! Now class continues to contain empty current text value.
-//! 12. Bison receive a token and call RecordListStart (), it
+//! 12. Bison receive a token and call RecordListStart (), it
//! creates a new record with "$1" ident and "ADVANCED_FACE" type
//! old record is the next of the new record.
//! Now current record has ident, type, but args are empty.
//! 13. Flex rule detected "#124" call CreateNewText("#124",4) and send token "IDENT",
//! Now class contains "#124", as current text value.
-//! 14. Bison receive a token and call CreateNewArg (), it
+//! 14. Bison receive a token and call CreateNewArg (), it
//! creates a new argument with "#124" text value and 'Ident' type.
//! Now current record has ident, type and one argument.
//! 15. Flex rule detected ")" send token ")".
//! Now class continues to contain "#124", as a current text value.
-//! 16. Bison receive a token and call RecordNewEntity (), it
+//! 16. Bison receive a token and call RecordNewEntity (), it
//! contain record to the records page, prepare to the new record
//! and get next record as a current record and set a new arg as a sub_record.
//! Now current record is a old record, it has ident, type and two args.
//! 17. Flex rule detected "#125" call CreateNewText, SetTypeArg and send token IDEND.
//! Now class contains "#125", as a current text value.
-//! 18. Bison receive a token and call CreateNewArg (), it
+//! 18. Bison receive a token and call CreateNewArg (), it
//! creates a new argument with "#125" text value and 'Ident' type.
//! Now current record has ident, type and three argument.
//! 19. Flex rule detected "#125" call CreateNewText, SetTypeArg and send token IDEND.
//! Now class contains "#125", as a current text value.
-//! 20. Bison receive a token and call CreateNewArg (), it
+//! 20. Bison receive a token and call CreateNewArg (), it
//! creates a new argument with "#125" text value and 'Ident' type.
//! Now current record has ident, type and three argument.
//! ...
//! Sets Format for Range to a new value with its range of
//! application.
//! To cancel it, give format as "" (empty string)
- //! Remark that if the condition (0. < Rmin < Rmax) is not
+ //! Remark that if the condition (0. < Rmin < Rmax) is not
//! verified, this secondary format will be ignored.
//! Moreover, this secondary format is intended to be used in a
//! range around 1.
class TCollection_HAsciiString;
//! This package implements the mapping between AP214
-//! Shape representation and CAS.CAD Shape Representation.
+//! Shape representation and CAS.CAD Shape Representation.
//! The source schema is Part42 (which is included in AP214)
class StepToTopoDS
{
const Message_ProgressRange& theProgress = Message_ProgressRange());
//! write the meshing in a file following the
- //! Ascii format of an STL file.
+ //! Ascii format of an STL file.
//! Returns false if the cannot be opened;
Standard_EXPORT static Standard_Boolean WriteAscii(
const Handle(Poly_Triangulation)& theMesh,
//! Call method Read() to read the file. In the process of reading, the tool will call methods
//! addNode() and addTriangle() to fill the mesh data structure.
//!
-//! The nodes with equal coordinates are merged automatically on the fly.
+//! The nodes with equal coordinates are merged automatically on the fly.
class RWStl_Reader : public Standard_Transient
{
DEFINE_STANDARD_RTTIEXT(RWStl_Reader, Standard_Transient)
#include <Standard_OStream.hxx>
#include <Standard_CString.hxx>
-//! Vrml package implements the specification of the
-//! VRML ( Virtual Reality Modeling Language ). VRML
-//! is a standard language for describing interactive
-//! 3-D objects and worlds delivered across Internet.
+//! Vrml package implements the specification of the
+//! VRML (Virtual Reality Modeling Language ). VRML
+//! is a standard language for describing interactive
+//! 3-D objects and worlds delivered across Internet.
//! Actual version of Vrml package have made for objects
//! of VRML version 1.0.
//! This package is used by VrmlConverter package.
-//! The developer should already be familiar with VRML
+//! The developer should already be familiar with VRML
//! specification before using this package.
class Vrml
{
DEFINE_STANDARD_ALLOC
//! Writes a header in anOStream (VRML file).
- //! Writes one line of commentary in anOStream (VRML file).
+ //! Writes one line of commentary in anOStream (VRML file).
Standard_EXPORT static Standard_OStream& VrmlHeaderWriter(Standard_OStream& anOStream);
Standard_EXPORT static Standard_OStream& CommentWriter(const Standard_CString aComment,
DEFINE_STANDARD_HANDLE(Vrml_AsciiText, Standard_Transient)
//! defines a AsciiText node of VRML specifying geometry shapes.
-//! This node represents strings of text characters from ASCII coded
-//! character set. All subsequent strings advance y by -( size * spacing).
+//! This node represents strings of text characters from ASCII coded
+//! character set. All subsequent strings advance y by -( size * spacing).
//! The justification field determines the placement of the strings in the x
//! dimension. LEFT (the default) places the left edge of each string at x=0.
//! CENTER places the center of each string at x=0. RIGHT places the right edge
//! of each string at x=0. Text is rendered from left to right, top to
//! bottom in the font set by FontStyle.
-//! The default value for the wigth field indicates the natural width
-//! should be used for that string.
+//! The default value for the wigth field indicates the natural width
+//! should be used for that string.
class Vrml_AsciiText : public Standard_Transient
{
#include <Standard_OStream.hxx>
//! defines a Cone node of VRML specifying geometry shapes.
-//! This node represents a simple cone, whose central axis is aligned
-//! with the y-axis. By default , the cone is centred at (0,0,0)
-//! and has size of -1 to +1 in the all three directions.
-//! the cone has a radius of 1 at the bottom and height of 2,
-//! with its apex at 1 and its bottom at -1. The cone has two parts:
-//! the sides and the bottom
+//! This node represents a simple cone, whose central axis is aligned
+//! with the y-axis. By default, the cone is centred at (0,0,0)
+//! and has size of -1 to +1 in the all three directions.
+//! the cone has a radius of 1 at the bottom and height of 2,
+//! with its apex at 1 and its bottom at -1. The cone has two parts:
+//! the sides and the bottom
class Vrml_Cone
{
public:
#include <Standard_OStream.hxx>
//! defines a Cube node of VRML specifying geometry shapes.
-//! This node represents a cuboid aligned with the coordinate axes.
-//! By default , the cube is centred at (0,0,0) and measures 2 units
-//! in each dimension, from -1 to +1.
+//! This node represents a cuboid aligned with the coordinate axes.
+//! By default, the cube is centred at (0,0,0) and measures 2 units
+//! in each dimension, from -1 to +1.
//! A cube's width is its extent along its object-space X axis, its height is
//! its extent along the object-space Y axis, and its depth is its extent along its
//! object-space Z axis.
#include <Standard_OStream.hxx>
//! defines a Cylinder node of VRML specifying geometry shapes.
-//! This node represents a simple capped cylinder centred around the y-axis.
-//! By default , the cylinder is centred at (0,0,0)
-//! and has size of -1 to +1 in the all three dimensions.
-//! The cylinder has three parts:
-//! the sides, the top (y=+1) and the bottom (y=-1)
+//! This node represents a simple capped cylinder centred around the y-axis.
+//! By default, the cylinder is centred at (0,0,0)
+//! and has size of -1 to +1 in the all three dimensions.
+//! The cylinder has three parts:
+//! the sides, the top (y=+1) and the bottom (y=-1)
class Vrml_Cylinder
{
public:
#include <gp_Vec.hxx>
#include <Standard_OStream.hxx>
-//! defines a directional light node of VRML specifying
+//! defines a directional light node of VRML specifying
//! properties of lights.
-//! This node defines a directional light source that illuminates
-//! along rays parallel to a given 3-dimensional vector
-//! Color is written as an RGB triple.
+//! This node defines a directional light source that illuminates
+//! along rays parallel to a given 3-dimensional vector
+//! Color is written as an RGB triple.
//! Light intensity must be in the range 0.0 to 1.0, inclusive.
class Vrml_DirectionalLight
{
//! defines a FontStyle node of VRML of properties of geometry
//! and its appearance.
-//! The size field specifies the height (in object space units)
-//! of glyphs rendered and determines the vertical spacing of
-//! adjacent lines of text.
+//! The size field specifies the height (in object space units)
+//! of glyphs rendered and determines the vertical spacing of
+//! adjacent lines of text.
class Vrml_FontStyle
{
public:
//! specifies a material or normal for each polyline. PER_VERTEX specifies a material or
//! normal for each vertex. The corresponding _INDEXED bindings are the same, but use
//! the materialIndex or normalIndex indices. The DEFAULT material binding is equal
-//! to OVERALL. The DEFAULT normal binding is equal to PER_VERTEX_INDEXED;
+//! to OVERALL. The DEFAULT normal binding is equal to PER_VERTEX_INDEXED;
//! if insufficient normals exist in the state, the lines will be drawn unlit. The same
//! rules for texture coordinate generation as IndexedFaceSet are used.
class Vrml_IndexedLineSet : public Standard_Transient
//! defines a Info node of VRML specifying properties of geometry
//! and its appearance.
-//! It is used to store information in the scene graph,
-//! Typically for application-specific purposes, copyright messages,
-//! or other strings.
+//! It is used to store information in the scene graph,
+//! Typically for application-specific purposes, copyright messages,
+//! or other strings.
class Vrml_Info
{
public:
#include <TCollection_AsciiString.hxx>
#include <Standard_OStream.hxx>
-//! defines "instancing" - using the same instance of a node
-//! multiple times.
-//! It is accomplished by using the "DEF" and "USE" keywords.
-//! The DEF keyword both defines a named node, and creates a single
-//! instance of it.
-//! The USE keyword indicates that the most recently defined instance
-//! should be used again.
-//! If several nades were given the same name, then the last DEF
-//! encountered during parsing "wins".
-//! DEF/USE is limited to a single file.
+//! defines "instancing" - using the same instance of a node
+//! multiple times.
+//! It is accomplished by using the "DEF" and "USE" keywords.
+//! The DEF keyword both defines a named node, and creates a single
+//! instance of it.
+//! The USE keyword indicates that the most recently defined instance
+//! should be used again.
+//! If several nades were given the same name, then the last DEF
+//! encountered during parsing "wins".
+//! DEF/USE is limited to a single file.
class Vrml_Instancing
{
public:
DEFINE_STANDARD_ALLOC
- //! Adds "DEF <myName>" in anOStream (VRML file).
+ //! Adds "DEF <myName>" in anOStream (VRML file).
Standard_EXPORT Vrml_Instancing(const TCollection_AsciiString& aString);
- //! Adds "USE <myName>" in anOStream (VRML file).
+ //! Adds "USE <myName>" in anOStream (VRML file).
Standard_EXPORT Standard_OStream& DEF(Standard_OStream& anOStream) const;
Standard_EXPORT Standard_OStream& USE(Standard_OStream& anOStream) const;
//! defines a LOD (level of detailization) node of VRML specifying properties
//! of geometry and its appearance.
-//! This group node is used to allow applications to switch between
-//! various representations of objects automatically. The children of this
-//! node typically represent the same object or objects at the varying
-//! of Levels Of Detail (LOD), from highest detail to lowest.
+//! This group node is used to allow applications to switch between
+//! various representations of objects automatically. The children of this
+//! node typically represent the same object or objects at the varying
+//! of Levels Of Detail (LOD), from highest detail to lowest.
//!
-//! The specified center point of the LOD is transformed by current
-//! transformation into world space, and the distance from the transformed
-//! center to the world-space eye point is calculated.
-//! If thedistance is less than the first value in the ranges array,
-//! than the first child of the LOD group is drawn. If between
-//! the first and second values in the range array, the second child
-//! is drawn, etc.
-//! If there are N values in the range array, the LOD group should
-//! have N+1 children.
-//! Specifying too few children will result in the last child being
-//! used repeatedly for the lowest lewels of detail; if too many children
-//! are specified, the extra children w ll be ignored.
-//! Each value in the ranges array should be greater than the previous
-//! value, otherwise results are undefined.
+//! The specified center point of the LOD is transformed by current
+//! transformation into world space, and the distance from the transformed
+//! center to the world-space eye point is calculated.
+//! If thedistance is less than the first value in the ranges array,
+//! than the first child of the LOD group is drawn. If between
+//! the first and second values in the range array, the second child
+//! is drawn, etc.
+//! If there are N values in the range array, the LOD group should
+//! have N+1 children.
+//! Specifying too few children will result in the last child being
+//! used repeatedly for the lowest levels of detail; if too many children
+//! are specified, the extra children will be ignored.
+//! Each value in the ranges array should be greater than the previous
+//! value, otherwise results are undefined.
class Vrml_LOD : public Standard_Transient
{
//! defines a MatrixTransform node of VRML specifying matrix and transform
//! properties.
-//! This node defines 3D transformation with a 4 by 4 matrix.
-//! By default :
+//! This node defines 3D transformation with a 4 by 4 matrix.
+//! By default:
//! a11=1 a12=0 a13=0 a14=0
//! a21=0 a22=1 a23=0 a24=0
//! a31=0 a32=0 a33=1 a34=0
//! a41=0 a42=0 a43=0 a44=1
-//! It is written to the file in row-major order as 16 Real numbers
-//! separated by whitespace. For example , matrix expressing a translation
-//! of 7.3 units along the X axis is written as:
+//! It is written to the file in row-major order as 16 Real numbers
+//! separated by whitespace. For example , matrix expressing a translation
+//! of 7.3 units along the X axis is written as:
//! 1 0 0 0 0 1 0 0 0 0 1 0 7.3 0 0 1
class Vrml_MatrixTransform
{
#include <gp_Vec.hxx>
#include <Standard_OStream.hxx>
-//! defines a point light node of VRML specifying
+//! defines a point light node of VRML specifying
//! properties of lights.
-//! This node defines a point light source at a fixed 3D location
-//! A point source illuminates equally in all directions;
-//! that is omni-directional.
-//! Color is written as an RGB triple.
+//! This node defines a point light source at a fixed 3D location
+//! A point source illuminates equally in all directions;
+//! that is omni-directional.
+//! Color is written as an RGB triple.
//! Light intensity must be in the range 0.0 to 1.0, inclusive.
class Vrml_PointLight
{
#include <Standard_OStream.hxx>
//! defines a Rotation node of VRML specifying matrix and transform properties.
-//! This node defines a 3D rotation about an arbitrary axis through the origin.
-//! By default : myRotation = (0 0 1 0)
+//! This node defines a 3D rotation about an arbitrary axis through the origin.
+//! Bydefault: myRotation = (0 0 1 0)
class Vrml_Rotation
{
public:
#include <Standard_Real.hxx>
//! defines SFRotation type of VRML field types.
-//! The 4 values represent an axis of rotation followed by amount of
-//! right-handed rotation about the that axis, in radians.
+//! The 4 values represent an axis of rotation followed by amount of
+//! right-handed rotation about the that axis, in radians.
class Vrml_SFRotation
{
public:
//! defines a Scale node of VRML specifying transform
//! properties.
-//! This node defines a 3D scaling about the origin.
-//! By default :
-//! myRotation = (1 1 1)
+//! This node defines a 3D scaling about the origin.
+//! By default:
+//! myRotation = (1 1 1)
class Vrml_Scale
{
public:
#include <Standard_OStream.hxx>
//! defines a Sphere node of VRML specifying geometry shapes.
-//! This node represents a sphere.
-//! By default , the sphere is centred at (0,0,0) and has a radius of 1.
+//! This node represents a sphere.
+//! By default, the sphere is centred at (0,0,0) and has a radius of 1.
class Vrml_Sphere
{
public:
//! specifies a spot light node of VRML nodes specifying
//! properties of lights.
-//! This node defines a spotlight light source.
-//! A spotlight is placed at a fixed location in 3D-space
-//! and illuminates in a cone along a particular direction.
-//! The intensity of the illumination drops off exponentially
-//! as a ray of light diverges from this direction toward
-//! the edges of cone.
-//! The rate of drop-off and agle of the cone are controlled
-//! by the dropOfRate and cutOffAngle
-//! Color is written as an RGB triple.
+//! This node defines a spotlight light source.
+//! A spotlight is placed at a fixed location in 3D-space
+//! and illuminates in a cone along a particular direction.
+//! The intensity of the illumination drops off exponentially
+//! as a ray of light diverges from this direction toward
+//! the edges of cone.
+//! The rate of drop-off and agle of the cone are controlled
+//! by the dropOfRate and cutOffAngle
+//! Color is written as an RGB triple.
//! Light intensity must be in the range 0.0 to 1.0, inclusive.
class Vrml_SpotLight
{
#include <Standard_OStream.hxx>
//! defines a Switch node of VRML specifying group properties.
-//! This group node traverses one, none, or all of its children.
-//! One can use this node to switch on and off the effects of some
-//! properties or to switch between different properties.
-//! The whichChild field specifies the index of the child to traverse,
-//! where the first child has index 0.
-//! A value of -1 (the default) means do not traverse any children.
-//! A value of -3 traverses all children, making the switch behave exactly
-//! like a regular Group.
+//! This group node traverses one, none, or all of its children.
+//! One can use this node to switch on and off the effects of some
+//! properties or to switch between different properties.
+//! The whichChild field specifies the index of the child to traverse,
+//! where the first child has index 0.
+//! A value of -1 (the default) means do not traverse any children.
+//! A value of -3 traverses all children, making the switch behave exactly
+//! like a regular Group.
class Vrml_Switch
{
public:
//! defines a Texture2 node of VRML specifying properties of geometry
//! and its appearance.
-//! This property node defines a texture map and parameters for that map
-//! The texture can be read from the URL specified by the filename field.
-//! To turn off texturing, set the filename field to an empty string ("").
-//! Textures can alsobe specified inline by setting the image field
-//! to contain the texture data.
-//! By default :
+//! This property node defines a texture map and parameters for that map
+//! The texture can be read from the URL specified by the filename field.
+//! To turn off texturing, set the filename field to an empty string ("").
+//! Textures can alsobe specified inline by setting the image field
+//! to contain the texture data.
+//! By default:
//! myFilename ("")
//! myImage (0 0 0)
//! myWrapS (Vrml_REPEAT)
//! defines a Texture2Transform node of VRML specifying properties of geometry
//! and its appearance.
-//! This node defines a 2D transformation applied to texture coordinates.
-//! This affect the way textures are applied to the surfaces of subsequent
+//! This node defines a 2D transformation applied to texture coordinates.
+//! This affect the way textures are applied to the surfaces of subsequent
//! shapes.
-//! Transformation consisits of(in order) a non-uniform scale about an
-//! arbitrary center point, a rotation about that same point, and
-//! a translation. This allows a user to change the size and position of
-//! the textures on the shape.
-//! By default :
+//! Transformation consisits of (in order) a non-uniform scale about an
+//! arbitrary center point, a rotation about that same point, and
+//! a translation. This allows a user to change the size and position of
+//! the textures on the shape.
+//! By default:
//! myTranslation (0 0)
//! myRotation (0)
//! myScaleFactor (1 1)
//! defines a TextureCoordinate2 node of VRML specifying properties of geometry
//! and its appearance.
-//! This node defines a set of 2D coordinates to be used to map textures
-//! to the vertices of subsequent PointSet, IndexedLineSet, or IndexedFaceSet
-//! objects. It replaces the current texture coordinates in the rendering
-//! state for the shapes to use.
-//! Texture coordinates range from 0 to 1 across the texture.
-//! The horizontal coordinate, called S, is specified first, followed
-//! by vertical coordinate, T.
-//! By default :
+//! This node defines a set of 2D coordinates to be used to map textures
+//! to the vertices of subsequent PointSet, IndexedLineSet, or IndexedFaceSet
+//! objects. It replaces the current texture coordinates in the rendering
+//! state for the shapes to use.
+//! Texture coordinates range from 0 to 1 across the texture.
+//! The horizontal coordinate, called S, is specified first, followed
+//! by vertical coordinate, T.
+//! By default:
//! myPoint (0 0)
class Vrml_TextureCoordinate2 : public Standard_Transient
{
//! defines a Transform of VRML specifying transform
//! properties.
-//! This node defines a geometric 3D transformation consisting of (in order)
-//! a (possibly) non-uniform scale about an arbitrary point, a rotation about
-//! an arbitrary point and axis and translation.
-//! By default :
+//! This node defines a geometric 3D transformation consisting of (in order)
+//! a (possibly) non-uniform scale about an arbitrary point, a rotation about
+//! an arbitrary point and axis and translation.
+//! By default:
//! myTranslation (0,0,0)
//! myRotation (0,0,1,0)
//! myScaleFactor (1,1,1)
#include <Standard_OStream.hxx>
//! defines a TransformSeparator node of VRML specifying group properties.
-//! This group node is similar to separator node in that it saves state
-//! before traversing its children and restores it afterwards.
-//! This node can be used to isolate transformations to light sources
-//! or objects.
+//! This group node is similar to separator node in that it saves state
+//! before traversing its children and restores it afterwards.
+//! This node can be used to isolate transformations to light sources
+//! or objects.
class Vrml_TransformSeparator
{
public:
//! defines a Translation of VRML specifying transform
//! properties.
-//! This node defines a translation by 3D vector.
-//! By default :
+//! This node defines a translation by 3D vector.
+//! By default:
//! myTranslation (0,0,0)
class Vrml_Translation
{
#include <Standard_OStream.hxx>
//! defines a WWWAnchor node of VRML specifying group properties.
-//! The WWWAnchor group node loads a new scene into a VRML browser
-//! when one of its children is closen. Exactly how a user "chooses"
-//! a child of the WWWAnchor is up to the VRML browser.
-//! WWWAnchor with an empty ("") name does nothing when its
-//! children are chosen.
-//! WWWAnchor behaves like a Separator, pushing the traversal state
-//! before traversing its children and popping it afterwards.
+//! The WWWAnchor group node loads a new scene into a VRML browser
+//! when one of its children is closen. Exactly how a user "chooses"
+//! a child of the WWWAnchor is up to the VRML browser.
+//! WWWAnchor with an empty ("") name does nothing when its
+//! children are chosen.
+//! WWWAnchor behaves like a Separator, pushing the traversal state
+//! before traversing its children and popping it afterwards.
class Vrml_WWWAnchor
{
public:
#include <Standard_OStream.hxx>
//! defines a WWWInline node of VRML specifying group properties.
-//! The WWWInline group node reads its children from anywhere in the
-//! World Wide Web.
-//! Exactly when its children are read is not defined;
-//! reading the children may be delayed until the WWWInline is actually
+//! The WWWInline group node reads its children from anywhere in the
+//! World Wide Web.
+//! Exactly when its children are read is not defined;
+//! reading the children may be delayed until the WWWInline is actually
//! displayed.
-//! WWWInline with an empty ("") name does nothing.
-//! WWWInline behaves like a Separator, pushing the traversal state
-//! before traversing its children and popping it afterwards.
-//! By defaults:
+//! WWWInline with an empty ("") name does nothing.
+//! WWWInline behaves like a Separator, pushing the traversal state
+//! before traversing its children and popping it afterwards.
+//! By defaults:
//! myName ("")
//! myBboxSize (0,0,0)
//! myBboxCenter (0,0,0)
class VrmlConverter_Drawer;
//! Curve - computes the presentation of objects to be
-//! seen as curves (the computation will be made
-//! with a constant number of points), converts this one
-//! into VRML objects and writes (adds) them into
-//! anOStream. All requested properties of the
-//! representation are specify in aDrawer of Drawer
+//! seen as curves (the computation will be made
+//! with a constant number of points), converts this one
+//! into VRML objects and writes (adds) them into
+//! anOStream. All requested properties of the
+//! representation are specify in aDrawer of Drawer
//! class (VrmlConverter).
//! This kind of the presentation is converted into
-//! IndexedLineSet ( VRML ).
+//! IndexedLineSet (VRML).
class VrmlConverter_Curve
{
public:
class Adaptor3d_Curve;
class VrmlConverter_Drawer;
-//! DeflectionCurve - computes the presentation of
-//! objects to be seen as curves, converts this one into
-//! VRML objects and writes (adds) into
-//! anOStream. All requested properties of the
-//! representation are specify in aDrawer.
-//! This kind of the presentation
-//! is converted into IndexedLineSet ( VRML ).
+//! DeflectionCurve - computes the presentation of
+//! objects to be seen as curves, converts this one into
+//! VRML objects and writes (adds) into
+//! anOStream. All requested properties of the
+//! representation are specify in aDrawer.
+//! This kind of the presentation
+//! is converted into IndexedLineSet (VRML).
//! The computation will be made according to a maximal
//! chordial deviation.
class VrmlConverter_DeflectionCurve
Standard_EXPORT VrmlConverter_Drawer();
//! by default: TOD_Relative; however, except for the shapes,
- //! the drawing will be made using the absolute deviation.
+ //! the drawing will be made using the absolute deviation.
Standard_EXPORT void SetTypeOfDeflection(const Aspect_TypeOfDeflection aTypeOfDeflection);
Standard_EXPORT Aspect_TypeOfDeflection TypeOfDeflection() const;
//! Defines the maximal chordial deviation when drawing any curve;
- //! If this value is one of the obvious parameters of methods,
- //! current value from Drawer won't be used.
+ //! If this value is one of the obvious parameters of methods,
+ //! current value from Drawer won't be used.
//! This value is used by:
//!
//! VrmlConverter_DeflectionCurve
Standard_EXPORT Standard_Real DeviationCoefficient() const;
//! default: 17 points.
- //! Defines the Discretisation (myNbPoints) when drawing any curve;
- //! If this value is one of the obvious parameters of methods,
- //! current value from Drawer won't be used.
+ //! Defines the Discretisation (myNbPoints) when drawing any curve;
+ //! If this value is one of the obvious parameters of methods,
+ //! current value from Drawer won't be used.
//! This value is used by:
//!
//! VrmlConverter_Curve
Standard_EXPORT Standard_Integer Discretisation() const;
- //! defines the maximum value allowed for the first and last
+ //! defines the maximum value allowed for the first and last
//! parameters of an infinite curve.
//! Default value: 500.
//! VrmlConverter_Curve
Standard_EXPORT void SetFreeBoundaryAspect(const Handle(VrmlConverter_LineAspect)& anAspect);
//! enables the drawing the free boundaries
- //! By default the free boundaries are drawn.
+ //! By default the free boundaries are drawn.
Standard_EXPORT void SetFreeBoundaryDraw(const Standard_Boolean OnOff);
//! returns True if the drawing of the free boundaries is enabled.
Standard_EXPORT void SetWireAspect(const Handle(VrmlConverter_LineAspect)& anAspect);
//! enables the drawing the wire
- //! By default the wire are drawn.
+ //! By default the wire are drawn.
Standard_EXPORT void SetWireDraw(const Standard_Boolean OnOff);
//! returns True if the drawing of the wire is enabled.
Standard_EXPORT void SetUnFreeBoundaryAspect(const Handle(VrmlConverter_LineAspect)& anAspect);
//! enables the drawing the unfree boundaries
- //! By default the unfree boundaries are drawn.
+ //! By default the unfree boundaries are drawn.
Standard_EXPORT void SetUnFreeBoundaryDraw(const Standard_Boolean OnOff);
//! returns True if the drawing of the unfree boundaries is enabled.
//! By default the hidden lines are not drawn.
Standard_EXPORT Standard_Boolean DrawHiddenLine() const;
- //! sets DrawHiddenLine = Standard_True - the hidden lines are drawn.
+ //! sets DrawHiddenLine = Standard_True - the hidden lines are drawn.
Standard_EXPORT void EnableDrawHiddenLine();
- //! sets DrawHiddenLine = Standard_False - the hidden lines are not drawn.
+ //! sets DrawHiddenLine = Standard_False - the hidden lines are not drawn.
Standard_EXPORT void DisableDrawHiddenLine();
- //! returns LineAspect for the hidden lines.
+ //! returns LineAspect for the hidden lines.
//! The default values are the same default values from Vrml package.
Standard_EXPORT Handle(VrmlConverter_LineAspect) HiddenLineAspect();
- //! sets LineAspect for the hidden lines.
+ //! sets LineAspect for the hidden lines.
Standard_EXPORT void SetHiddenLineAspect(const Handle(VrmlConverter_LineAspect)& anAspect);
- //! returns LineAspect for the seen lines.
+ //! returns LineAspect for the seen lines.
//! The default values are the same default values from Vrml package.
Standard_EXPORT Handle(VrmlConverter_LineAspect) SeenLineAspect();
- //! sets LineAspect for the seen lines.
+ //! sets LineAspect for the seen lines.
Standard_EXPORT void SetSeenLineAspect(const Handle(VrmlConverter_LineAspect)& anAspect);
DEFINE_STANDARD_RTTIEXT(VrmlConverter_Drawer, Standard_Transient)
class VrmlConverter_Drawer;
class VrmlConverter_Projector;
-//! HLRShape - computes the presentation of objects
+//! HLRShape - computes the presentation of objects
//! with removal of their hidden lines for a specific
-//! projector, converts them into VRML objects and
-//! writes (adds) them into anOStream. All requested
-//! properties of the representation are specify in
-//! aDrawer of Drawer class. This kind of the presentation
-//! is converted into IndexedLineSet and if they are defined
-//! in Projector into :
+//! projector, converts them into VRML objects and
+//! writes (adds) them into anOStream. All requested
+//! properties of the representation are specify in
+//! aDrawer of Drawer class. This kind of the presentation
+//! is converted into IndexedLineSet and if they are defined
+//! in Projector info:
//! PerspectiveCamera,
//! OrthographicCamera,
//! DirectionLight,
//! PointLight,
//! SpotLight
-//! from Vrml package.
+//! from Vrml package.
class VrmlConverter_HLRShape
{
public:
DEFINE_STANDARD_HANDLE(VrmlConverter_IsoAspect, VrmlConverter_LineAspect)
//! qualifies the aspect properties for
-//! the VRML conversation of iso curves .
+//! the VRML conversation of iso curves.
class VrmlConverter_IsoAspect : public VrmlConverter_LineAspect
{
public:
//! create a default IsoAspect.
- //! Default value: myNumber - 10.
+ //! Default value: myNumber - 10.
Standard_EXPORT VrmlConverter_IsoAspect();
Standard_EXPORT VrmlConverter_IsoAspect(const Handle(Vrml_Material)& aMaterial,
DEFINE_STANDARD_HANDLE(VrmlConverter_LineAspect, Standard_Transient)
//! qualifies the aspect properties for
-//! the VRML conversation of a Curve and a DeflectionCurve .
+//! the VRML conversation of a Curve and a DeflectionCurve.
class VrmlConverter_LineAspect : public Standard_Transient
{
public:
//! create a default LineAspect.
- //! Default value: HasMaterial = False - a line hasn't own material (color)
+ //! Default value: HasMaterial = False - a line hasn't own material (color)
Standard_EXPORT VrmlConverter_LineAspect();
Standard_EXPORT VrmlConverter_LineAspect(const Handle(Vrml_Material)& aMaterial,
Standard_EXPORT Handle(Vrml_Material) Material() const;
- //! defines the necessary of writing own Material from Vrml into output OStream.
- //! By default False - the material is not writing into OStream,
- //! True - the material is writing.
+ //! defines the necessary of writing own Material from Vrml into output OStream.
+ //! By default False - the material is not writing into OStream,
+ //! True - the material is writing.
Standard_EXPORT void SetHasMaterial(const Standard_Boolean OnOff);
- //! returns True if the materials is writing into OStream.
+ //! returns True if the materials is writing into OStream.
Standard_EXPORT Standard_Boolean HasMaterial() const;
DEFINE_STANDARD_RTTIEXT(VrmlConverter_LineAspect, Standard_Transient)
public:
//! create a default PointAspect.
- //! Default value: HasMaterial = False - a line hasn't own material (color)
+ //! Default value: HasMaterial = False - a line hasn't own material (color)
Standard_EXPORT VrmlConverter_PointAspect();
Standard_EXPORT VrmlConverter_PointAspect(const Handle(Vrml_Material)& aMaterial,
Standard_EXPORT Handle(Vrml_Material) Material() const;
- //! defines the necessary of writing own Material from Vrml into output OStream.
- //! By default False - the material is not writing into OStream,
- //! True - the material is writing.
+ //! defines the necessary of writing own Material from Vrml into output OStream.
+ //! By default False - the material is not writing into OStream,
+ //! True - the material is writing.
Standard_EXPORT void SetHasMaterial(const Standard_Boolean OnOff);
- //! returns True if the materials is writing into OStream.
+ //! returns True if the materials is writing into OStream.
Standard_EXPORT Standard_Boolean HasMaterial() const;
DEFINE_STANDARD_RTTIEXT(VrmlConverter_PointAspect, Standard_Transient)
class VrmlConverter_Projector;
DEFINE_STANDARD_HANDLE(VrmlConverter_Projector, Standard_Transient)
-//! defines projector and calculates properties of cameras and lights from Vrml
-//! ( OrthograpicCamera, PerspectiveCamera, DirectionalLight, PointLight, SpotLight
-//! and MatrixTransform ) to display all scene shapes with arbitrary locations
-//! for requested the Projection Vector, High Point Direction and the Focus
-//! and adds them ( method Add ) to anOSream.
+//! defines projector and calculates properties of cameras and lights from Vrml
+//! (OrthograpicCamera, PerspectiveCamera, DirectionalLight, PointLight, SpotLight
+//! and MatrixTransform) to display all scene shapes with arbitrary locations
+//! for requested the Projection Vector, High Point Direction and the Focus
+//! and adds them (method Add) to anOSream.
class VrmlConverter_Projector : public Standard_Transient
{
Standard_EXPORT VrmlConverter_TypeOfLight Light() const;
- //! Adds into anOStream if they are defined in Create.
+ //! Adds into anOStream if they are defined in Create.
//! PerspectiveCamera,
//! OrthographicCamera,
//! DirectionLight,
//! PointLight,
//! SpotLight
- //! with MatrixTransform from VrmlConverter;
+ //! with MatrixTransform from VrmlConverter;
Standard_EXPORT void Add(Standard_OStream& anOStream) const;
Standard_EXPORT HLRAlgo_Projector Projector() const;
class TopoDS_Face;
class Poly_Connect;
-//! ShadedShape - computes the shading presentation of shapes
+//! ShadedShape - computes the shading presentation of shapes
//! by triangulation algorithms, converts this one into VRML objects
//! and writes (adds) into anOStream.
//! All requested properties of the representation including
-//! the maximal chordial deviation are specify in aDrawer.
-//! This kind of the presentation is converted into
-//! IndexedFaceSet ( VRML ).
+//! the maximal chordial deviation are specify in aDrawer.
+//! This kind of the presentation is converted into
+//! IndexedFaceSet (VRML).
class VrmlConverter_ShadedShape
{
public:
DEFINE_STANDARD_HANDLE(VrmlConverter_ShadingAspect, Standard_Transient)
//! qualifies the aspect properties for
-//! the VRML conversation of ShadedShape .
+//! the VRML conversation of ShadedShape.
class VrmlConverter_ShadingAspect : public Standard_Transient
{
Standard_EXPORT Vrml_ShapeHints ShapeHints() const;
- //! defines necessary of a calculation of normals for ShadedShape to more
- //! accurately display curved surfaces, pacticularly when smoooth or phong
- //! shading is used in VRML viewer.
- //! By default False - the normals are not calculated,
- //! True - the normals are calculated.
- //! Warning: If normals are calculated the resulting VRML file will
- //! be substantially lager.
+ //! defines necessary of a calculation of normals for ShadedShape to more
+ //! accurately display curved surfaces, pacticularly when smoooth or phong
+ //! shading is used in VRML viewer.
+ //! By default False - the normals are not calculated,
+ //! True - the normals are calculated.
+ //! Warning: If normals are calculated the resulting VRML file will
+ //! be substantially lager.
Standard_EXPORT void SetHasNormals(const Standard_Boolean OnOff);
//! returns True if the normals are calculating
Standard_EXPORT Standard_Boolean HasNormals() const;
- //! defines necessary of writing Material from Vrml into output OStream.
- //! By default False - the material is not writing into OStream,
- //! True - the material is writing.
+ //! defines necessary of writing Material from Vrml into output OStream.
+ //! By default False - the material is not writing into OStream,
+ //! True - the material is writing.
Standard_EXPORT void SetHasMaterial(const Standard_Boolean OnOff);
- //! returns True if the materials is writing into OStream.
+ //! returns True if the materials is writing into OStream.
Standard_EXPORT Standard_Boolean HasMaterial() const;
DEFINE_STANDARD_RTTIEXT(VrmlConverter_ShadingAspect, Standard_Transient)
class VrmlConverter_Drawer;
-//! WFDeflectionRestrictedFace - computes the
-//! wireframe presentation of faces with
-//! restrictions by displaying a given number of U
-//! and/or V isoparametric curves, converts his
-//! into VRML objects and writes (adds) them into
-//! anOStream. All requested properties of the
-//! representation are specify in aDrawer of Drawer
-//! class (Prs3d). This kind of the presentation
-//! is converted into IndexedFaceSet and
-//! IndexedLineSet ( VRML ).
+//! WFDeflectionRestrictedFace - computes the
+//! wireframe presentation of faces with
+//! restrictions by displaying a given number of U
+//! and/or V isoparametric curves, converts his
+//! into VRML objects and writes (adds) them into
+//! anOStream. All requested properties of the
+//! representation are specify in aDrawer of Drawer
+//! class (Prs3d). This kind of the presentation
+//! is converted into IndexedFaceSet and
+//! IndexedLineSet (VRML).
class VrmlConverter_WFDeflectionRestrictedFace
{
public:
class TopoDS_Shape;
class VrmlConverter_Drawer;
-//! WFDeflectionShape - computes the wireframe
-//! presentation of compound set of faces, edges and
-//! vertices by displaying a given number of U and/or
-//! V isoparametric curves, converts this one into VRML
+//! WFDeflectionShape - computes the wireframe
+//! presentation of compound set of faces, edges and
+//! vertices by displaying a given number of U and/or
+//! V isoparametric curves, converts this one into VRML
//! objects and writes (adds) them into anOStream.
//! All requested properties of the representation are
//! specify in aDrawer.
-//! This kind of the presentation is converted into
-//! IndexedLineSet and PointSet ( VRML ).
+//! This kind of the presentation is converted into
+//! IndexedLineSet and PointSet (VRML).
class VrmlConverter_WFDeflectionShape
{
public:
class VrmlConverter_Drawer;
-//! WFRestrictedFace - computes the wireframe
-//! presentation of faces with restrictions by
-//! displaying a given number of U and/or V
-//! isoparametric curves, converts this one into VRML
-//! objects and writes (adds) into anOStream.
-//! All requested properties of the representation
-//! are specify in aDrawer.
+//! WFRestrictedFace - computes the wireframe
+//! presentation of faces with restrictions by
+//! displaying a given number of U and/or V
+//! isoparametric curves, converts this one into VRML
+//! objects and writes (adds) into anOStream.
+//! All requested properties of the representation
+//! are specify in aDrawer.
//! This kind of the presentation is converted into
-//! IndexedLineSet ( VRML ).
+//! IndexedLineSet (VRML).
class VrmlConverter_WFRestrictedFace
{
public:
class VrmlConverter_Drawer;
//! WFShape - computes the wireframe presentation of
-//! compound set of faces, edges and vertices by
-//! displaying a given number of U and/or V isoparametric
+//! compound set of faces, edges and vertices by
+//! displaying a given number of U and/or V isoparametric
//! curves converts this one into VRML objects and writes (adds)
//! them into anOStream.
//! All requested properties of the representation are
//! specify in aDrawer.
//! This kind of the presentation is converted into
-//! IndexedLineSet and PointSet ( VRML ).
+//! IndexedLineSet and PointSet (VRML).
class VrmlConverter_WFShape
{
public:
{
public:
- //! class methods working on the node
- //! ===================================
- //! Shortcut to search a Graph node attribute with default
- //! GraphID. Returns true if found.
+ //! class methods working on the node
+ //! =================================
+ //! Shortcut to search a Graph node attribute with default
+ //! GraphID. Returns true if found.
Standard_EXPORT static Standard_Boolean Find(const TDF_Label& L, Handle(XCAFDoc_GraphNode)& G);
//! Finds or Creates a GraphNode attribute on the label <L>
- //! with the default Graph ID, returned by the method
- //! <GetDefaultGraphID>. Returns the created/found GraphNode
+ //! with the default Graph ID, returned by the method
+ //! <GetDefaultGraphID>. Returns the created/found GraphNode
//! attribute.
Standard_EXPORT static Handle(XCAFDoc_GraphNode) Set(const TDF_Label& L);
- //! Finds or Creates a GraphNode attribute on the label
- //! <L>, with an explicit tree ID. <ExplicitGraphID> is
- //! the ID returned by <TDF_Attribute::ID> method.
+ //! Finds or Creates a GraphNode attribute on the label
+ //! <L>, with an explicit tree ID. <ExplicitGraphID> is
+ //! the ID returned by <TDF_Attribute::ID> method.
//! Returns the found/created GraphNode attribute.
Standard_EXPORT static Handle(XCAFDoc_GraphNode) Set(const TDF_Label& L,
const Standard_GUID& ExplicitGraphID);
- //! returns a default Graph ID. this ID is used by the
+ //! returns a default Graph ID. this ID is used by the
//! <Set> method without explicit tree ID.
//! Instance methods:
//! ================
projects / occt.git / commitdiff