Abstract3dModel (JavaSCAD 0.9.2.2 API)

java.lang.Object
- eu.printingin3d.javascad.models.Abstract3dModel

All Implemented Interfaces:

IModel

Direct Known Subclasses:

Atomic3dModel, Complex3dModel
```
public abstract class Abstract3dModel
extends Object
implements IModel
```
Immutable implementation of IModel interface and adds convenient methods to make it easier to move or rotate the 3D models. Every primitive 3D object and 3D transition extend this class.

None of the methods changing this object rather creates a new object with the changes and gives that changed object back. This make cloning and other similar techniques unnecessary.

Author:

ivivan

Constructor Summary

Constructors
Constructor and Description

Abstract3dModel()

Constructors
Constructor and Description
`Abstract3dModel()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Abstract3dModel`	`addModel(Abstract3dModel model)` Convenient method to create a Union.
`Abstract3dModel`	`addModelTo(Side side, Abstract3dModel model)` Convenient method to create a Union.
`Abstract3dModel`	`align(Side place, Abstract3dModel model)` Moves this model to the position relative to the given model.
`Abstract3dModel`	`align(Side place, Abstract3dModel model, boolean inside)` Deprecated. Use `align(Side, Abstract3dModel)` instead.
`Abstract3dModel`	`align(Side place, Coords3d coords)` Moves this model to the position relative to the given coordinate.
`Abstract3dModel`	`align(String innerAnnotation, Side place, Abstract3dModel model)` Moves this model to the position relative to the annotated part of the given model.
`Abstract3dModel`	`align(String innerAnnotation, Side place, Abstract3dModel model, String externalAnnotation)` Moves this model to the position relative to the annotated part of the given model.
`Abstract3dModel`	`annotate(String annotation)` Annotate this object with the given annotation.
`Abstract3dModel`	`background()` Creates a new object with the background flag set, which means it will render in a transparent light gray color in preview mode and is skipped in CGAL rendering or STL export.
`protected Abstract3dModel`	`cloneModel()` Creates a clone of this model, so after the cloning any change on it won't affect.
`Abstract3dModel`	`debug()` Creates a new object with the debug flag set, which means it is rendered in a different color in preview mode (it does not affect the CGAL rendering or STL export).
`protected List<Abstract3dModel>`	`findAnnotatedModel(String annotation)`
`Boundaries3d`	`getBoundaries()` Calculate the including cuboid for the current model.
`protected abstract List<Abstract3dModel>`	`getChildrenModels()`
`protected abstract Boundaries3d`	`getModelBoundaries()`
`protected int`	`getTag()` For testing purposes only.
`protected abstract Abstract3dModel`	`innerCloneModel()`
`protected abstract Abstract3dModel`	`innerSubModel(IScadGenerationContext context)`
`protected abstract SCAD`	`innerToScad(IColorGenerationContext context)` Generates the OpenSCAD representation of the model without.
`protected boolean`	`isBackground()` For testing purposes only.
`protected boolean`	`isDebug()` For testing purposes only.
`boolean`	`isMoved()` Returns true if this object is moved false otherwise.
`protected abstract boolean`	`isPrimitive()` Returns true if and only if this object represents a primitive, atomic 3D object.
`boolean`	`isRotated()` Returns true if the result will contain rotating transformation.
`Abstract3dModel`	`move(Coords3d delta)` Moves this object by the given coordinates.
`Abstract3dModel`	`moves(Collection<Coords3d> delta)` Add moves to this model, which converts this to an `Union`, representing more than one model.
`Abstract3dModel`	`moves(Coords3d... delta)` Add moves to this model, which converts this to an `Union`, representing more than one model.
`Abstract3dModel`	`moves(List<Coords3d> delta, List<String> annotations)` Add moves to this model, which converts this to an `Union`, representing more than one model.
`Abstract3dModel`	`moves(List<Coords3d> delta, String... annotations)` Add moves to this model, which converts this to an `Union`, representing more than one model.
`Abstract3dModel`	`rotate(Angles3d delta)` Creates a new object by rotating this object with the given angle.
`Abstract3dModel`	`rotates(Angles3d... delta)` Add rotates to this model, which converts this to an `Union`, representing more than one model.
`Abstract3dModel`	`rotates(Collection<Angles3d> delta)` Add rotates to this model, which converts this to an `Union`, representing more than one model.
`Abstract3dModel`	`round(Plane plane, double radius)` Rounding this object with the given radius.
`Abstract3dModel`	`subModel(IScadGenerationContext context)` Copies parts of the model to a new model based on the given context.
`Abstract3dModel`	`subtractModel(Abstract3dModel model)` Convenient method to create a Difference.
`CSG`	`toCSG()` Renders this model to its CSG interpretation - convenient method which used the default generation context.
`CSG`	`toCSG(FacetGenerationContext aContext)` Renders this model to its CSG interpretation.
`protected abstract CSG`	`toInnerCSG(FacetGenerationContext context)`
`SCAD`	`toScad(IColorGenerationContext context)` Renders this model and returns with the generated OpenSCAD code.
`Abstract3dModel`	`withTag(int tag)` Tag the model with the given value.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Abstract3dModel
```
public Abstract3dModel()
```
- Method Detail
  - move
```
public Abstract3dModel move(Coords3d delta)
```
    Moves this object by the given coordinates. This object won't be changed, but a new object will be created.
    
    Parameters:
    
    delta - the coordinates used by the move
    
    Returns:
    
    the new object created
  - moves
```
public Abstract3dModel moves(Collection<Coords3d> delta)
```
    Add moves to this model, which converts this to an Union, representing more than one model.
    
    Parameters:
    
    delta - the collection of coordinates used by the move operation
    
    Returns:
    
    a new object which holds the moved objects
  - moves
```
public Abstract3dModel moves(List<Coords3d> delta,
                             String... annotations)
```
    Add moves to this model, which converts this to an Union, representing more than one model.
    
    The moved objects is annotated with the given list of annotations respectively. There has to be an equal number of moves and annotations given, otherwise an exception is thrown.
    
    If any item in the annotations list is null that copy of the object won't be annotated.
    
    It is very convenient with the use of Coords3d.createVariances. For example:
    object.moves(new Coords3d(1,1,0).createVariances(), "+1+1", "+1-1", "-1+1", "-1-1")
    Parameters:
    
    delta - the collection of coordinates used by the move operation
    
    annotations - the list of annotations to be used
    
    Returns:
    
    a new object which holds the moved objects
    
    Throws:
    
    IllegalValueException - in case the number of moves and annotations are not equal
  - moves
```
public Abstract3dModel moves(List<Coords3d> delta,
                             List<String> annotations)
```
    Add moves to this model, which converts this to an Union, representing more than one model.
    
    The moved objects is annotated with the given list of annotations respectively. There has to be an equal number of moves and annotations given, otherwise an exception is thrown.
    
    If any item in the annotations list is null that copy of the object won't be annotated.
    
    Parameters:
    
    delta - the collection of coordinates used by the move operation
    
    annotations - the list of annotations to be used
    
    Returns:
    
    a new object which holds the moved objects
    
    Throws:
    
    IllegalValueException - in case the number of moves and annotations are not equal
  - moves
```
public Abstract3dModel moves(Coords3d... delta)
```
    Add moves to this model, which converts this to an Union, representing more than one model.
    
    Parameters:
    
    delta - the collection of coordinates used by the move operation
    
    Returns:
    
    a new object which holds the moved objects
  - rotate
```
public Abstract3dModel rotate(Angles3d delta)
```
    Creates a new object by rotating this object with the given angle.
    
    Parameters:
    
    delta - the angle it will be rotated
    
    Returns:
    
    the new object created
  - rotates
```
public Abstract3dModel rotates(Collection<Angles3d> delta)
```
    Add rotates to this model, which converts this to an Union, representing more than one model. This object won't be changed.
    
    Parameters:
    
    delta - the collection of angles used by the rotate operation
    
    Returns:
    
    a new object which holds the moved objects
  - rotates
```
public Abstract3dModel rotates(Angles3d... delta)
```
    Add rotates to this model, which converts this to an Union, representing more than one model. This object won't be changed.
    
    Parameters:
    
    delta - the collection of angles used by the rotate operation
    
    Returns:
    
    a new object which holds the moved objects
  - debug
```
public Abstract3dModel debug()
```
    Creates a new object with the debug flag set, which means it is rendered in a different color in preview mode (it does not affect the CGAL rendering or STL export). It is quite useful debugging Difference.
    
    Returns:
    
    the new object created
  - background
```
public Abstract3dModel background()
```
    Creates a new object with the background flag set, which means it will render in a transparent light gray color in preview mode and is skipped in CGAL rendering or STL export. This is mainly used as a helping object for reference during the sketch.
    
    Returns:
    
    the new object created
  - getChildrenModels
```
protected abstract List<Abstract3dModel> getChildrenModels()
```
  - findAnnotatedModel
```
protected final List<Abstract3dModel> findAnnotatedModel(String annotation)
```
  - annotate
```
public Abstract3dModel annotate(String annotation)
```
    Annotate this object with the given annotation.
    
    An object can be annotated by several annotation at the same time. A new annotation never overrides an old one.
    
    If the given parameter is null this method does nothing.
    
    Parameters:
    
    annotation - the annotation will be used - can be null
    
    Returns:
    
    the new object created
  - cloneModel
```
protected final Abstract3dModel cloneModel()
```
    Creates a clone of this model, so after the cloning any change on it won't affect. this model
    
    Returns:
    
    a copy of this model
  - innerCloneModel
```
protected abstract Abstract3dModel innerCloneModel()
```
  - innerToScad
```
protected abstract SCAD innerToScad(IColorGenerationContext context)
```
    Generates the OpenSCAD representation of the model without. and moves or rotations
    
    Returns:
    
    the representation of the model
  - isPrimitive
```
protected abstract boolean isPrimitive()
```
    Returns true if and only if this object represents a primitive, atomic 3D object. This method used internally and must return true in build in primitives.
    
    Returns:
    
    true if and only if this object represents a primitive, atomic 3D object
  - toScad
```
public final SCAD toScad(IColorGenerationContext context)
```
    Description copied from interface: IModel
    
    Renders this model and returns with the generated OpenSCAD code.
    
    Specified by:
    
    toScad in interface IModel
    
    Parameters:
    
    context - the color context to be used for the generation
    
    Returns:
    
    the generated OpenSCAD code
  - getModelBoundaries
```
protected abstract Boundaries3d getModelBoundaries()
```
  - getBoundaries
```
public final Boundaries3d getBoundaries()
```
    Calculate the including cuboid for the current model. Rotation is not yet supported.
    
    Returns:
    
    the calculated boundaries
  - isRotated
```
public boolean isRotated()
```
    Returns true if the result will contain rotating transformation.
    
    Returns:
    
    true if the result will contain rotating transformation
  - isMoved
```
public boolean isMoved()
```
    Returns true if this object is moved false otherwise.
    
    Returns:
    
    true if this object is moved false otherwise
  - align
```
@Deprecated
public Abstract3dModel align(Side place,
                                          Abstract3dModel model,
                                          boolean inside)
```
    Deprecated. Use align(Side, Abstract3dModel) instead.
    
    Moves this model to the position relative to the given model. The position is controlled by the place - see Side - and inside parameters.
    
    Parameters:
    
    place - where to move this model
    
    model - the model used as a reference point
    
    inside - controls which side of the aligned model will be aligned
    
    Returns:
    
    the new object created
  - align
```
public Abstract3dModel align(Side place,
                             Abstract3dModel model)
```
    Moves this model to the position relative to the given model. The position is controlled by the place - see Side - parameter.
    
    Parameters:
    
    place - where to move this model
    
    model - the model used as a reference point
    
    Returns:
    
    the new object created
  - align
```
public Abstract3dModel align(String innerAnnotation,
                             Side place,
                             Abstract3dModel model)
```
    Moves this model to the position relative to the annotated part of the given model. The position is controlled by the place - see Side - parameter.
    
    Parameters:
    
    innerAnnotation - the annotated part of this object which will be used for the positioning. Can be null which case it does filter anything and the call is equivalent to align(place, model)
    
    place - where to move this model
    
    model - the model used as a reference point
    
    Returns:
    
    the new object created
    
    Throws:
    
    IllegalValueException - if there are more than one pieces of this model is annotated with innerAnnotation
  - align
```
public Abstract3dModel align(String innerAnnotation,
                             Side place,
                             Abstract3dModel model,
                             String externalAnnotation)
```
    Moves this model to the position relative to the annotated part of the given model. The position is controlled by the place - see Side - parameter.
    
    In case more than one pieces of the target object is annotated with externalAnnotation this model will be aligned to all of them and the returned object will be the union of those new objects.
    
    Parameters:
    
    innerAnnotation - the annotated part of this object which will be used for the positioning. Can be null which case it does not filter on the source side.
    
    place - where to move this model
    
    model - the model used as a reference point
    
    externalAnnotation - the annotation used to filter the target object. Can be null which case it does not filter on the target side.
    
    Returns:
    
    the new object created
    
    Throws:
    
    IllegalValueException - if there are more than one pieces of this model is annotated with innerAnnotation or if there are no pieces of the target model is annotated with externalAnnotation
  - align
```
public Abstract3dModel align(Side place,
                             Coords3d coords)
```
    Moves this model to the position relative to the given coordinate. The position is controlled by the place - see Side.
    
    Parameters:
    
    place - where to move this model
    
    coords - the coordinates used as a reference point
    
    Returns:
    
    the new object created
  - round
```
public Abstract3dModel round(Plane plane,
                             double radius)
                      throws IllegalValueException
```
    Rounding this object with the given radius. It is possible to round only on one plane, or rounding all around the object.
    
    Please pay attention that the rounding increases the objects size with the given radius.
    
    Parameters:
    
    plane - the rounding will happen on this plane - or all around if it set to ALL.
    
    radius - the radius of the rounding
    
    Returns:
    
    the newly created object
    
    Throws:
    
    IllegalValueException - if the given radius is negative
  - toInnerCSG
```
protected abstract CSG toInnerCSG(FacetGenerationContext context)
```
  - toCSG
```
public final CSG toCSG(FacetGenerationContext aContext)
```
    Description copied from interface: IModel
    
    Renders this model to its CSG interpretation.
    
    Specified by:
    
    toCSG in interface IModel
    
    Parameters:
    
    aContext - the context to be used during the generation process.
    
    Returns:
    
    the CSG interpretation
  - toCSG
```
public final CSG toCSG()
```
    Renders this model to its CSG interpretation - convenient method which used the default generation context.
    
    Returns:
    
    the CSG interpretation
  - withTag
```
public Abstract3dModel withTag(int tag)
```
    Tag the model with the given value. This value can be used to color objects and include / exclude them from the export.
    
    Parameters:
    
    tag - the value to be used
    
    Returns:
    
    this object to make it possible to chain more method call
  - addModel
```
public Abstract3dModel addModel(Abstract3dModel model)
```
    Convenient method to create a Union.
    
    Parameters:
    
    model - the model to be added to this object
    
    Returns:
    
    a new model which contains the union of this object and the given object
  - addModelTo
```
public Abstract3dModel addModelTo(Side side,
                                  Abstract3dModel model)
```
    Convenient method to create a Union. Adding the given model to the side of this model. Calling model1.addModelTo(side, model2) is always equivalent to model1.addModel(model2.align(side, model1, false)).
    
    Parameters:
    
    side - where to move this model
    
    model - the model to be added to this object
    
    Returns:
    
    a new model which contains the union of this object and the given object
    
    See Also:
    
    addModel(Abstract3dModel)
  - subtractModel
```
public Abstract3dModel subtractModel(Abstract3dModel model)
```
    Convenient method to create a Difference.
    
    Parameters:
    
    model - the model to be subtracted to this object
    
    Returns:
    
    a new model which contains the difference of this object and the given object
  - innerSubModel
```
protected abstract Abstract3dModel innerSubModel(IScadGenerationContext context)
```
  - subModel
```
public Abstract3dModel subModel(IScadGenerationContext context)
```
    Copies parts of the model to a new model based on the given context. It is very useful if we want to use a tagged part of the model as a separate model. Lots of things can be done to the new model: we can render it or we can use it to align to it.
    
    If the given context is the ScadGenerationContextFactory.DEFAULT then this method call is logically equivalent to a cloneModel() method call.
    
    Parameters:
    
    context - the context to be used as a filter during the copy process.
    
    Returns:
    
    a copy of the selected parts of this model
  - getTag
```
protected int getTag()
```
    For testing purposes only.
    
    Returns:
    
    the tag of the model
  - isDebug
```
protected boolean isDebug()
```
    For testing purposes only.
    
    Returns:
    
    the debug flag of the model
  - isBackground
```
protected boolean isBackground()
```
    For testing purposes only.
    
    Returns:
    
    the background flag of the model

Class Abstract3dModel

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Abstract3dModel

Method Detail

move

moves

moves

moves

moves

rotate

rotates

rotates

debug

background

getChildrenModels

findAnnotatedModel

annotate

cloneModel

innerCloneModel

innerToScad

isPrimitive

toScad

getModelBoundaries

getBoundaries

isRotated

isMoved

align

align

align

align

align

round

toInnerCSG

toCSG

toCSG

withTag

addModel

addModelTo

subtractModel

innerSubModel

subModel

getTag

isDebug

isBackground