OCCT 8.0.1
OCCT documentation

Search guides and API reference

Enter at least two characters.
    Open CASCADE Technology Reference Manual 8.0.1
    VrmlData_ArrayVec3d Class Reference

    #include <VrmlData_ArrayVec3d.hxx>

    Inheritance diagram for VrmlData_ArrayVec3d:
    Inheritance graph
    [legend]

    Public Member Functions

     VrmlData_ArrayVec3d ()
     VrmlData_ArrayVec3d (const VrmlData_Scene &theScene, const char *theName, const size_t nVec, const gp_XYZ *arrVec)
    size_t Length () const
    const gp_XYZ * Values () const
    bool AllocateValues (const size_t theLength)
    void SetValues (const size_t nValues, const gp_XYZ *arrValues)
    VrmlData_ErrorStatus ReadArray (VrmlData_InBuffer &theBuffer, const char *theName, const bool isScale)
    VrmlData_ErrorStatus WriteArray (const char *theName, const bool isScale) const
    bool IsDefault () const override
    Public Member Functions inherited from VrmlData_Node
     VrmlData_Node ()
     ~VrmlData_Node () override=default
    const VrmlData_Scene & Scene () const
    const char * Name () const
    VrmlData_ErrorStatus ReadNode (VrmlData_InBuffer &theBuffer, occ::handle< VrmlData_Node > &theNode, const occ::handle< Standard_Type > &Type=nullptr)
    virtual VrmlData_ErrorStatus Read (VrmlData_InBuffer &theBuffer)=0
    virtual VrmlData_ErrorStatus Write (const char *thePrefix) const
    VrmlData_ErrorStatus WriteClosing () const
    virtual occ::handle< VrmlData_Node > Clone (const occ::handle< VrmlData_Node > &) const
    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 ()=default
     Destructor must be virtual.
    virtual const opencascade::handle< Standard_Type > & DynamicType () const
     Returns a type descriptor about this object.
    bool IsInstance (const opencascade::handle< Standard_Type > &theType) const
     Returns a true value if this is an instance of Type.
    bool IsInstance (const char *const theTypeName) const
     Returns a true value if this is an instance of TypeName.
    bool 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.
    bool IsKind (const char *const 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.
    int GetRefCount () const noexcept
     Get the reference counter of this object.
    void IncrementRefCounter () noexcept
     Increments the reference counter of this object. Uses relaxed memory ordering since incrementing only requires atomicity, not synchronization with other memory operations.
    int DecrementRefCounter () noexcept
     Decrements the reference counter of this object; returns the decremented value. Uses release ordering for the decrement to ensure all writes to the object are visible before the count reaches zero. An acquire fence is added only when the count reaches zero, ensuring proper synchronization before deletion. This is more efficient than using acq_rel for every decrement.
    virtual void Delete () const
     Memory deallocator for transient classes.

    Protected Member Functions

    const gp_XYZ & Value (const size_t i) const
    Protected Member Functions inherited from VrmlData_Node
     VrmlData_Node (const VrmlData_Scene &theScene, const char *theName)

    Protected Attributes

    const gp_XYZ * myArray
    size_t myLength

    Additional Inherited Members

    typedef void base_type
     Returns a type descriptor about this object.
    Static Public Member Functions inherited from VrmlData_Node
    static VrmlData_ErrorStatus ReadBoolean (VrmlData_InBuffer &theBuffer, bool &theResult)
    static VrmlData_ErrorStatus ReadString (VrmlData_InBuffer &theBuffer, TCollection_AsciiString &theRes)
    static VrmlData_ErrorStatus ReadMultiString (VrmlData_InBuffer &theBuffer, NCollection_List< TCollection_AsciiString > &theRes)
    static VrmlData_ErrorStatus ReadInteger (VrmlData_InBuffer &theBuffer, long &theResult)
    static bool OK (const VrmlData_ErrorStatus theStat)
    static bool OK (VrmlData_ErrorStatus &outStat, const VrmlData_ErrorStatus theStat)
    static int GlobalIndent ()
    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.
    Static Protected Member Functions inherited from VrmlData_Node
    static VrmlData_ErrorStatus readBrace (VrmlData_InBuffer &theBuffer)

    Detailed Description

    Implementatioon of basic node for Coordinate, Normal and Color (array of triplets).

    Constructor & Destructor Documentation

    ◆ VrmlData_ArrayVec3d() [1/2]

    VrmlData_ArrayVec3d::VrmlData_ArrayVec3d ( )
    		inline

    Empty constructor

    ◆ VrmlData_ArrayVec3d() [2/2]

    VrmlData_ArrayVec3d::VrmlData_ArrayVec3d ( const VrmlData_Scene & theScene,
    const char * theName,
    const size_t nVec,
    const gp_XYZ * arrVec )
    		inline

    Constructor

    Member Function Documentation

    ◆ AllocateValues()

    bool VrmlData_ArrayVec3d::AllocateValues ( const size_t theLength)

    Create a data array and assign the field myArray.

    Returns
    True if allocation was successful.

    ◆ IsDefault()

    bool VrmlData_ArrayVec3d::IsDefault ( ) const
    		overridevirtual

    Returns True if the node is default, so that it should not be written.

    Reimplemented from VrmlData_Node.

    ◆ Length()

    size_t VrmlData_ArrayVec3d::Length ( ) const
    		inline

    Query the number of vectors

    ◆ ReadArray()

    VrmlData_ErrorStatus VrmlData_ArrayVec3d::ReadArray ( VrmlData_InBuffer & theBuffer,
    const char * theName,
    const bool isScale )

    Create a copy of this node. If the parameter is null, a new copied node is created. Otherwise new node is not created, but rather the given one is modified. Read the Node from input stream.

    ◆ SetValues()

    void VrmlData_ArrayVec3d::SetValues ( const size_t nValues,
    const gp_XYZ * arrValues )
    		inline

    Set the array data

    ◆ Value()

    const gp_XYZ & VrmlData_ArrayVec3d::Value ( const size_t i) const
    		protected

    Query one vector

    Parameters
    iindex in the array of vectors [0 .. N-1]
    Returns
    the vector for the index. If index irrelevant, returns (0., 0., 0.)

    ◆ Values()

    const gp_XYZ * VrmlData_ArrayVec3d::Values ( ) const
    		inline

    Query the array

    ◆ WriteArray()

    VrmlData_ErrorStatus VrmlData_ArrayVec3d::WriteArray ( const char * theName,
    const bool isScale ) const

    Write the Node to the output stream currently opened in Scene.

    Field Documentation

    ◆ myArray

    const gp_XYZ* VrmlData_ArrayVec3d::myArray
    		protected

    ◆ myLength

    size_t VrmlData_ArrayVec3d::myLength
    		protected
    The documentation for this class was generated from the following file: