OCCT/src/FoundationClasses/TKMath/TopLoc/TopLoc_Location.cxx

// Created on: 1991-01-21
// Created by: Christophe MARION
// Copyright (c) 1991-1999 Matra Datavision
// Copyright (c) 1999-2014 OPEN CASCADE SAS
//
// This file is part of Open CASCADE Technology software library.
//
// This library is free software; you can redistribute it and/or modify it under
// the terms of the GNU Lesser General Public License version 2.1 as published
// by the Free Software Foundation, with special exception defined in the file
// OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
// distribution for complete text of the license and disclaimer of any warranty.
//
// Alternatively, this file may be used under the terms of Open CASCADE
// commercial license or contractual agreement.

#define No_Standard_NoSuchObject

#include <gp_Trsf.hxx>
#include <Standard_Dump.hxx>
#include <TopLoc_Datum3D.hxx>
#include <TopLoc_Location.hxx>
#include <TopLoc_SListOfItemLocation.hxx>

//=================================================================================================

TopLoc_Location::TopLoc_Location() {}

//=================================================================================================

TopLoc_Location::TopLoc_Location(const Handle(TopLoc_Datum3D)& D)
{
  myItems.Construct(TopLoc_ItemLocation(D, 1));
}

//=================================================================================================

TopLoc_Location::TopLoc_Location(const gp_Trsf& T)
{
  Handle(TopLoc_Datum3D) D = new TopLoc_Datum3D(T);
  myItems.Construct(TopLoc_ItemLocation(D, 1));
}

//=================================================================================================

const gp_Trsf& TopLoc_Location::Transformation() const
{
  static const gp_Trsf THE_IDENTITY_TRSF;
  if (IsIdentity())
    return THE_IDENTITY_TRSF;
  else
    return myItems.Value().myTrsf;
}

TopLoc_Location::operator gp_Trsf() const
{
  return Transformation();
}

//=================================================================================================

TopLoc_Location TopLoc_Location::Inverted() const
{
  //
  // the inverse of a Location is a chain in revert order
  // with opposite powers and same Local
  //
  TopLoc_Location            result;
  TopLoc_SListOfItemLocation items = myItems;
  while (items.More())
  {
    result.myItems.Construct(TopLoc_ItemLocation(items.Value().myDatum, -items.Value().myPower));
    items.Next();
  }
  return result;
}

//=======================================================================
// function : Multiplied
// purpose  : operator *
//=======================================================================

TopLoc_Location TopLoc_Location::Multiplied(const TopLoc_Location& Other) const
{
  // prepend the chain Other in front of this
  // cancelling null exponents

  if (IsIdentity())
    return Other;
  if (Other.IsIdentity())
    return *this;

  // prepend the queue of Other
  TopLoc_Location result = Multiplied(Other.NextLocation());
  // does the head of Other cancel the head of result

  Standard_Integer p = Other.FirstPower();
  if (!result.IsIdentity())
  {
    if (Other.FirstDatum() == result.FirstDatum())
    {
      p += result.FirstPower();
      result.myItems.ToTail();
    }
  }
  if (p != 0)
    result.myItems.Construct(TopLoc_ItemLocation(Other.FirstDatum(), p));
  return result;
}

//=======================================================================
// function : Divided
// purpose  : operator /   this*Other.Inverted()
//=======================================================================

TopLoc_Location TopLoc_Location::Divided(const TopLoc_Location& Other) const
{
  return Multiplied(Other.Inverted());
}

//=======================================================================
// function : Predivided
// purpose  : return Other.Inverted() * this
//=======================================================================

TopLoc_Location TopLoc_Location::Predivided(const TopLoc_Location& Other) const
{
  return Other.Inverted().Multiplied(*this);
}

//=================================================================================================

TopLoc_Location TopLoc_Location::Powered(const Standard_Integer pwr) const
{
  if (IsIdentity())
    return *this;
  if (pwr == 1)
    return *this;
  if (pwr == 0)
    return TopLoc_Location();

  // optimisation when just one element
  if (myItems.Tail().IsEmpty())
  {
    TopLoc_Location result;
    result.myItems.Construct(TopLoc_ItemLocation(FirstDatum(), FirstPower() * pwr));
    return result;
  }

  if (pwr > 0)
    return Multiplied(Powered(pwr - 1));
  else
    return Inverted().Powered(-pwr);
}

//=================================================================================================

// two locations are Equal if the Items have the same LocalValues and Powers
// this is a recursive function to test it

Standard_Boolean TopLoc_Location::IsEqual(const TopLoc_Location& Other) const
{
  const void** p = (const void**)&myItems;
  const void** q = (const void**)&Other.myItems;
  if (*p == *q)
  {
    return Standard_True;
  }
  if (IsIdentity() || Other.IsIdentity())
  {
    return Standard_False;
  }
  if (FirstDatum() != Other.FirstDatum())
  {
    return Standard_False;
  }
  if (FirstPower() != Other.FirstPower())
  {
    return Standard_False;
  }
  else
  {
    return NextLocation() == Other.NextLocation();
  }
}

//=================================================================================================

Standard_Boolean TopLoc_Location::IsDifferent(const TopLoc_Location& Other) const
{
  return !IsEqual(Other);
}

//=================================================================================================

void TopLoc_Location::DumpJson(Standard_OStream& theOStream, Standard_Integer theDepth) const
{
  OCCT_DUMP_CLASS_BEGIN(theOStream, TopLoc_Location)

  OCCT_DUMP_FIELD_VALUES_DUMPED(theOStream, theDepth, &Transformation())
  OCCT_DUMP_FIELD_VALUE_NUMERICAL(theOStream, IsIdentity())
}

//=================================================================================================

void TopLoc_Location::ShallowDump(Standard_OStream& S) const
{
  S << "TopLoc_Location : ";
  TopLoc_SListOfItemLocation items = myItems;
  if (items.IsEmpty())
    S << "Identity" << std::endl;
  while (items.More())
  {
    S << "\n";
    S << "       Exponent : " << items.Value().myPower << std::endl;
    items.Value().myDatum->ShallowDump(S);
    items.Next();
  }
  S << "\n";
}