RBFRectangle

Inheritance diagram

Inheritance diagram of ORSModel.ors.RBFRectangle, ORSModel.ors.SurfaceControlPoints, ORSModel.ors.Shape3D, ORSModel.ors.Shape, ORSModel.ors.Unmanaged, ORSModel.ors.ORSBaseClass

Classes

RBFRectangle

class ORSModel.ors.RBFRectangle

Bases: ORSModel.ors.SurfaceControlPoints

brief_description: None author: Nicolas Piche. All other members of ORS participated. version: 1.0 date: January 2010

copy(self) → RBFRectangle

Copies aRBFRectangle.

Note

The copied RBFRectangle has the same equation as the source RBFRectangle.

Returns:output (ORSModel.ors.RBFRectangle) – A new RBFRectangle (an RBFRectangle)
createFromPythonRepresentation(aPythonRepresentation: str) → RBFRectangle

Create aRBFRectangle from a python representation a static method.

Parameters:aPythonRepresentation (str) –
Returns:output (ORSModel.ors.RBFRectangle) –
getClassNameStatic() → str

getClassNameStatic

Returns:output (str) –
getIsEqualTo(self, RBFRectangle: ORSModel.ors.RBFRectangle) → bool

Verifies equality between the receiver and a givenRBFRectangle.

Parameters:RBFRectangle (ORSModel.ors.RBFRectangle) –
Returns:output (bool) – TRUE if the argument RBFRectangle is equal to the receiver, FALSE otherwise
getRectangle(self) → Rectangle
Returns:output (ORSModel.ors.Rectangle) –
none() → RBFRectangle
Returns:output (RBFRectangle) –
setRectangle(self, aRectangle: ORSModel.ors.Rectangle) → None
Parameters:aRectangle (ORSModel.ors.Rectangle) –
transform(self, transformationMatrix: ORSModel.ors.Matrix4x4) → None
Parameters:transformationMatrix (ORSModel.ors.Matrix4x4) –

SurfaceControlPoints

class ORSModel.ors.SurfaceControlPoints

Bases: ORSModel.ors.Shape3D

brief_description: None author: Nicolas Piche. All other members of ORS participated. version: 1.0 date: January 2010

copy(self) → SurfaceControlPoints

Copies aSurfaceControlPoints.

Note

The copied SurfaceControlPoints has the same equation as the source SurfaceControlPoints.

Returns:output (ORSModel.ors.SurfaceControlPoints) – A new SurfaceControlPoints (an SurfaceControlPoints)
getCenter(self) → Vector3

Gets the geometrical middle of the surface.

Returns:output (ORSModel.ors.Vector3) – a surface center position (an Vector3)
getClassNameStatic() → str

getClassNameStatic

Returns:output (str) –
getControlPoint(self, uIndex: int, vIndex: int) → Vector3
Parameters:
  • uIndex (int) –
  • vIndex (int) –
Returns:

output (ORSModel.ors.Vector3) –

getControlPointAtIndex(self, index: int) → Vector3
Parameters:index (int) –
Returns:output (ORSModel.ors.Vector3) –
getControlPointCount(self) → int
Returns:output (int) –
getIsEqualTo(self, SurfaceControlPoints: ORSModel.ors.SurfaceControlPoints) → bool

Verifies equality between the receiver and a givenSurfaceControlPoints.

Parameters:SurfaceControlPoints (ORSModel.ors.SurfaceControlPoints) –
Returns:output (bool) – TRUE if the argument SurfaceControlPoints is equal to the receiver, FALSE otherwise
getRotated(self, axisOfRotation: ORSModel.ors.Vector3, rotationCenter: ORSModel.ors.Vector3, angle: float) → SurfaceControlPoints
Parameters:
Returns:

output (ORSModel.ors.SurfaceControlPoints) –

getUControlPointCount(self) → int

get the U control point count

Returns:output (int) – a count
getVControlPointCount(self) → int
Returns:output (int) – a count (a uint32_t)
getValueAt(self, u: float, v: float) → Vector3
Parameters:
  • u (float) –
  • v (float) –
Returns:

output (ORSModel.ors.Vector3) –

none() → SurfaceControlPoints
Returns:output (SurfaceControlPoints) –
rotate(self, axisOfRotation: ORSModel.ors.Vector3, rotationCenter: ORSModel.ors.Vector3, angle: float) → None

Applies a rotation to the receiver.

Note

The box is a right handed bounded referential.

Parameters:
  • axisInWorld (ORSModel.ors.Vector3) – a rotation axis (an Vector3)
  • aroundPointInWorld (ORSModel.ors.Vector3) – a center of rotation (an Vector3)
  • angleInRadian (float) – an angle in radian (a double)
setControlPoint(self, uIndex: int, vIndex: int, controlPoint: ORSModel.ors.Vector3) → None
Parameters:
setControlPointAtIndex(self, index: int, controlPoint: ORSModel.ors.Vector3) → None
Parameters:
setSize(self, uControlPointCount: int, vControlPointCount: int) → None
Parameters:
  • uControlPointCount (int) –
  • vControlPointCount (int) –
transform(self, transformationMatrix: ORSModel.ors.Matrix4x4) → None
Parameters:transformationMatrix (ORSModel.ors.Matrix4x4) –

Shape3D

class ORSModel.ors.Shape3D

Bases: ORSModel.ors.Shape

getCanBeUsedForProjection(self) → bool
Returns:output (bool) –
getClassNameStatic() → str

getClassNameStatic

Returns:output (str) –
getIsPointInside(self, aPosition: ORSModel.ors.Vector3) → bool

Verifies if a point is inside the shape.

Parameters:aPosition (ORSModel.ors.Vector3) – a point (an Vector3)
Returns:output (bool) – TRUE if the point is inside the shape, FALSE otherwise
getIsPointInsideFromComponents(self, aPositionX: float, aPositionY: float, aPositionZ: float) → bool

Verifies if a point is inside the shape.

Parameters:
  • aPositionX (float) – a point X component (a double)
  • aPositionY (float) – a point Y component (a double)
  • aPositionZ (float) – a point Z component (a double)
Returns:

output (bool) – TRUE if the point is inside the shape, FALSE otherwise
getProjectionRectangle(self) → Rectangle
Returns:output (ORSModel.ors.Rectangle) –
none() → Shape3D
Returns:output (Shape3D) –

Shape

class ORSModel.ors.Shape

Bases: ORSModel.ors.Unmanaged

brief_description: None author: Nicolas Piche. All other members of ORS participated. version: 1.0 date: January 2017

copy(self) → Unmanaged

Gets a copy of the receiver.

Returns:output (ORSModel.ors.Unmanaged) – a shape
getClassNameStatic() → str

getClassNameStatic

Returns:output (str) –
getIsIntersectingShape(self, aShape: ORSModel.ors.Shape) → bool

Gets if the receiver intersects the given shape.

Parameters:aShape (ORSModel.ors.Shape) – a shape to intersect with the receiver (a Shape)
Returns:output (bool) – TRUE if the receiver intersects the shape, FALSE otherwise (a bool)
getRotated(self, axisOfRotation: ORSModel.ors.Vector3, rotationCenter: ORSModel.ors.Vector3, angle: float) → Shape
Parameters:
Returns:

output (ORSModel.ors.Shape) –

getTransformed(self, aMatrix: ORSModel.ors.Matrix4x4) → Shape
Parameters:aMatrix (ORSModel.ors.Matrix4x4) –
Returns:output (ORSModel.ors.Shape) –
none() → Shape
Returns:output (Shape) –
rotate(self, axisInWorld: ORSModel.ors.Vector3, aroundPointInWorld: ORSModel.ors.Vector3, angleInRadian: float) → None

Applies a rotation to the receiver.

Note

The box is a right handed bounded referential.

Parameters:
  • axisInWorld (ORSModel.ors.Vector3) – a rotation axis (an Vector3)
  • aroundPointInWorld (ORSModel.ors.Vector3) – a center of rotation (an Vector3)
  • angleInRadian (float) – an angle in radian (a double)
transform(self, transformationMatrix: ORSModel.ors.Matrix4x4) → None

Applies a transformation to the receiver.

Note

The transformation can include: translation, rotation and scaling.

Parameters:transformationMatrix (ORSModel.ors.Matrix4x4) – a transformation matrix (an Matrix4x4)

Unmanaged

class ORSModel.ors.Unmanaged

Bases: ORSModel.ors.ORSBaseClass

brief_description: Abstract class for objects that are not managed by the core library. author: Eric Fournier. All other members of ORS participated. version: 1.0 date: Jan 2005

atomicLoad(sFilename: str) → Unmanaged

Creates an object from a file where an object was saved.

Parameters:sFilename (str) – path of the file to load
Returns:output (Unmanaged) – a managed object, or none() if the load fails
atomicSave(self, aFilename: str) → int

Saves the object to a file.

Parameters:aFilename (str) – path of the file to save
Returns:output (int) – 0 if successful, otherwise an error code
createFromPythonRepresentation(aPythonRepresentation: str) → Unmanaged

Create aUnmanaged Object from a python representation a static method.

Parameters:aPythonRepresentation (str) –
Returns:output (ORSModel.ors.Unmanaged) –
fromPythonRepresentation(self, aPythonRepresentation: str) → bool

Create aUnmanaged object from a Python string representation.

Parameters:aPythonRepresentation (str) – a Python evaluable string representation (a string)
Returns:output (bool) – TRUE if parsing worked, FALSE otherwise (a bool)
classmethod getAllSubclasses(outputCollection=None)
classmethod getClassDenomination()
static getClassFromProgId(progId)
getClassName(self) → str

Retrieves the class name of the core object wrapped by this Interface object.

Returns:output (str) –
getClassNameStatic() → str

getClassNameStatic

Returns:output (str) –
getDataChecksum(self) → str
Returns:output (str) –
getIsInstanceOf(self, pProgId: str) → bool

Queries the object to know if it is an instance of a certain class.

Parameters:pProgId (str) –
Returns:output (bool) –
classmethod getIsSubclassOf(parentClass)
getPythonRepresentation(self) → str

Gets a Python evaluable string representation.

Returns:output (str) –
isNone(self) → bool

Checks if the receiver is none.

Returns:output (bool) –
isNotNone(self) → bool

Checks if the receiver is not none.

Returns:output (bool) –
none() → Unmanaged
Returns:output (Unmanaged) –

ORSBaseClass

class ORSModel.ors.ORSBaseClass

brief_description: An abstract class from which all objects issued from the author: Eric Fournier. All other members of ORS participated. version: 1.0 date: Jan 2005

getPythonTraceBack() → typing.List[str]

Set the python traceback for a call from python.

Returns:output (typing.List[str]) –
isManaged(self) → bool
Returns:output (bool) –
isNone(self) → bool
Returns:output (bool) –
setPythonTraceBack(tb: ORSModel.ors.typing.List[str]) → None

Set the python traceback for a call from python.

Parameters:tb (typing.List[str]) –