org.bimserver.models.ifc4.IfcSurfaceStyleRendering Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of PluginBase Show documentation
Base project for BIMserver plugin development. Some plugins mights also need the Shared library
There is a newer version: 2.0.0
/**
 * Copyright (C) 2009-2014 BIMserver.org
 * 
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 * 
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see .
 */
package org.bimserver.models.ifc4;

/**
 * 
 * A representation of the model object 'Ifc Surface Style Rendering'.
 * 
 *
 * 
 * The following features are supported:
 * 
 * 
 *   {@link org.bimserver.models.ifc4.IfcSurfaceStyleRendering#getTransparency Transparency}
 *   {@link org.bimserver.models.ifc4.IfcSurfaceStyleRendering#getTransparencyAsString Transparency As String}
 *   {@link org.bimserver.models.ifc4.IfcSurfaceStyleRendering#getDiffuseColour Diffuse Colour}
 *   {@link org.bimserver.models.ifc4.IfcSurfaceStyleRendering#getTransmissionColour Transmission Colour}
 *   {@link org.bimserver.models.ifc4.IfcSurfaceStyleRendering#getDiffuseTransmissionColour Diffuse Transmission Colour}
 *   {@link org.bimserver.models.ifc4.IfcSurfaceStyleRendering#getReflectionColour Reflection Colour}
 *   {@link org.bimserver.models.ifc4.IfcSurfaceStyleRendering#getSpecularColour Specular Colour}
 *   {@link org.bimserver.models.ifc4.IfcSurfaceStyleRendering#getSpecularHighlight Specular Highlight}
 *   {@link org.bimserver.models.ifc4.IfcSurfaceStyleRendering#getReflectanceMethod Reflectance Method}
 * 
 *
 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcSurfaceStyleRendering()
 * @model
 * @generated
 */
public interface IfcSurfaceStyleRendering extends IfcSurfaceStyleShading {
	/**
	 * Returns the value of the 'Transparency' attribute.
	 * 
	 * 
	 * If the meaning of the 'Transparency' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Transparency' attribute.
	 * @see #isSetTransparency()
	 * @see #unsetTransparency()
	 * @see #setTransparency(double)
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcSurfaceStyleRendering_Transparency()
	 * @model unsettable="true"
	 * @generated
	 */
	double getTransparency();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc4.IfcSurfaceStyleRendering#getTransparency Transparency}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Transparency' attribute.
	 * @see #isSetTransparency()
	 * @see #unsetTransparency()
	 * @see #getTransparency()
	 * @generated
	 */
	void setTransparency(double value);

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcSurfaceStyleRendering#getTransparency Transparency}' attribute.
	 * 
	 * 
	 * @see #isSetTransparency()
	 * @see #getTransparency()
	 * @see #setTransparency(double)
	 * @generated
	 */
	void unsetTransparency();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcSurfaceStyleRendering#getTransparency Transparency}' attribute is set.
	 * 
	 * 
	 * @return whether the value of the 'Transparency' attribute is set.
	 * @see #unsetTransparency()
	 * @see #getTransparency()
	 * @see #setTransparency(double)
	 * @generated
	 */
	boolean isSetTransparency();

	/**
	 * Returns the value of the 'Transparency As String' attribute.
	 * 
	 * 
	 * If the meaning of the 'Transparency As String' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Transparency As String' attribute.
	 * @see #isSetTransparencyAsString()
	 * @see #unsetTransparencyAsString()
	 * @see #setTransparencyAsString(String)
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcSurfaceStyleRendering_TransparencyAsString()
	 * @model unsettable="true"
	 * @generated
	 */
	String getTransparencyAsString();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc4.IfcSurfaceStyleRendering#getTransparencyAsString Transparency As String}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Transparency As String' attribute.
	 * @see #isSetTransparencyAsString()
	 * @see #unsetTransparencyAsString()
	 * @see #getTransparencyAsString()
	 * @generated
	 */
	void setTransparencyAsString(String value);

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcSurfaceStyleRendering#getTransparencyAsString Transparency As String}' attribute.
	 * 
	 * 
	 * @see #isSetTransparencyAsString()
	 * @see #getTransparencyAsString()
	 * @see #setTransparencyAsString(String)
	 * @generated
	 */
	void unsetTransparencyAsString();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcSurfaceStyleRendering#getTransparencyAsString Transparency As String}' attribute is set.
	 * 
	 * 
	 * @return whether the value of the 'Transparency As String' attribute is set.
	 * @see #unsetTransparencyAsString()
	 * @see #getTransparencyAsString()
	 * @see #setTransparencyAsString(String)
	 * @generated
	 */
	boolean isSetTransparencyAsString();

	/**
	 * Returns the value of the 'Diffuse Colour' reference.
	 * 
	 * 
	 * If the meaning of the 'Diffuse Colour' reference isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Diffuse Colour' reference.
	 * @see #isSetDiffuseColour()
	 * @see #unsetDiffuseColour()
	 * @see #setDiffuseColour(IfcColourOrFactor)
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcSurfaceStyleRendering_DiffuseColour()
	 * @model unsettable="true"
	 * @generated
	 */
	IfcColourOrFactor getDiffuseColour();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc4.IfcSurfaceStyleRendering#getDiffuseColour Diffuse Colour}' reference.
	 * 
	 * 
	 * @param value the new value of the 'Diffuse Colour' reference.
	 * @see #isSetDiffuseColour()
	 * @see #unsetDiffuseColour()
	 * @see #getDiffuseColour()
	 * @generated
	 */
	void setDiffuseColour(IfcColourOrFactor value);

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcSurfaceStyleRendering#getDiffuseColour Diffuse Colour}' reference.
	 * 
	 * 
	 * @see #isSetDiffuseColour()
	 * @see #getDiffuseColour()
	 * @see #setDiffuseColour(IfcColourOrFactor)
	 * @generated
	 */
	void unsetDiffuseColour();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcSurfaceStyleRendering#getDiffuseColour Diffuse Colour}' reference is set.
	 * 
	 * 
	 * @return whether the value of the 'Diffuse Colour' reference is set.
	 * @see #unsetDiffuseColour()
	 * @see #getDiffuseColour()
	 * @see #setDiffuseColour(IfcColourOrFactor)
	 * @generated
	 */
	boolean isSetDiffuseColour();

	/**
	 * Returns the value of the 'Transmission Colour' reference.
	 * 
	 * 
	 * If the meaning of the 'Transmission Colour' reference isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Transmission Colour' reference.
	 * @see #isSetTransmissionColour()
	 * @see #unsetTransmissionColour()
	 * @see #setTransmissionColour(IfcColourOrFactor)
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcSurfaceStyleRendering_TransmissionColour()
	 * @model unsettable="true"
	 * @generated
	 */
	IfcColourOrFactor getTransmissionColour();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc4.IfcSurfaceStyleRendering#getTransmissionColour Transmission Colour}' reference.
	 * 
	 * 
	 * @param value the new value of the 'Transmission Colour' reference.
	 * @see #isSetTransmissionColour()
	 * @see #unsetTransmissionColour()
	 * @see #getTransmissionColour()
	 * @generated
	 */
	void setTransmissionColour(IfcColourOrFactor value);

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcSurfaceStyleRendering#getTransmissionColour Transmission Colour}' reference.
	 * 
	 * 
	 * @see #isSetTransmissionColour()
	 * @see #getTransmissionColour()
	 * @see #setTransmissionColour(IfcColourOrFactor)
	 * @generated
	 */
	void unsetTransmissionColour();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcSurfaceStyleRendering#getTransmissionColour Transmission Colour}' reference is set.
	 * 
	 * 
	 * @return whether the value of the 'Transmission Colour' reference is set.
	 * @see #unsetTransmissionColour()
	 * @see #getTransmissionColour()
	 * @see #setTransmissionColour(IfcColourOrFactor)
	 * @generated
	 */
	boolean isSetTransmissionColour();

	/**
	 * Returns the value of the 'Diffuse Transmission Colour' reference.
	 * 
	 * 
	 * If the meaning of the 'Diffuse Transmission Colour' reference isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Diffuse Transmission Colour' reference.
	 * @see #isSetDiffuseTransmissionColour()
	 * @see #unsetDiffuseTransmissionColour()
	 * @see #setDiffuseTransmissionColour(IfcColourOrFactor)
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcSurfaceStyleRendering_DiffuseTransmissionColour()
	 * @model unsettable="true"
	 * @generated
	 */
	IfcColourOrFactor getDiffuseTransmissionColour();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc4.IfcSurfaceStyleRendering#getDiffuseTransmissionColour Diffuse Transmission Colour}' reference.
	 * 
	 * 
	 * @param value the new value of the 'Diffuse Transmission Colour' reference.
	 * @see #isSetDiffuseTransmissionColour()
	 * @see #unsetDiffuseTransmissionColour()
	 * @see #getDiffuseTransmissionColour()
	 * @generated
	 */
	void setDiffuseTransmissionColour(IfcColourOrFactor value);

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcSurfaceStyleRendering#getDiffuseTransmissionColour Diffuse Transmission Colour}' reference.
	 * 
	 * 
	 * @see #isSetDiffuseTransmissionColour()
	 * @see #getDiffuseTransmissionColour()
	 * @see #setDiffuseTransmissionColour(IfcColourOrFactor)
	 * @generated
	 */
	void unsetDiffuseTransmissionColour();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcSurfaceStyleRendering#getDiffuseTransmissionColour Diffuse Transmission Colour}' reference is set.
	 * 
	 * 
	 * @return whether the value of the 'Diffuse Transmission Colour' reference is set.
	 * @see #unsetDiffuseTransmissionColour()
	 * @see #getDiffuseTransmissionColour()
	 * @see #setDiffuseTransmissionColour(IfcColourOrFactor)
	 * @generated
	 */
	boolean isSetDiffuseTransmissionColour();

	/**
	 * Returns the value of the 'Reflection Colour' reference.
	 * 
	 * 
	 * If the meaning of the 'Reflection Colour' reference isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Reflection Colour' reference.
	 * @see #isSetReflectionColour()
	 * @see #unsetReflectionColour()
	 * @see #setReflectionColour(IfcColourOrFactor)
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcSurfaceStyleRendering_ReflectionColour()
	 * @model unsettable="true"
	 * @generated
	 */
	IfcColourOrFactor getReflectionColour();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc4.IfcSurfaceStyleRendering#getReflectionColour Reflection Colour}' reference.
	 * 
	 * 
	 * @param value the new value of the 'Reflection Colour' reference.
	 * @see #isSetReflectionColour()
	 * @see #unsetReflectionColour()
	 * @see #getReflectionColour()
	 * @generated
	 */
	void setReflectionColour(IfcColourOrFactor value);

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcSurfaceStyleRendering#getReflectionColour Reflection Colour}' reference.
	 * 
	 * 
	 * @see #isSetReflectionColour()
	 * @see #getReflectionColour()
	 * @see #setReflectionColour(IfcColourOrFactor)
	 * @generated
	 */
	void unsetReflectionColour();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcSurfaceStyleRendering#getReflectionColour Reflection Colour}' reference is set.
	 * 
	 * 
	 * @return whether the value of the 'Reflection Colour' reference is set.
	 * @see #unsetReflectionColour()
	 * @see #getReflectionColour()
	 * @see #setReflectionColour(IfcColourOrFactor)
	 * @generated
	 */
	boolean isSetReflectionColour();

	/**
	 * Returns the value of the 'Specular Colour' reference.
	 * 
	 * 
	 * If the meaning of the 'Specular Colour' reference isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Specular Colour' reference.
	 * @see #isSetSpecularColour()
	 * @see #unsetSpecularColour()
	 * @see #setSpecularColour(IfcColourOrFactor)
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcSurfaceStyleRendering_SpecularColour()
	 * @model unsettable="true"
	 * @generated
	 */
	IfcColourOrFactor getSpecularColour();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc4.IfcSurfaceStyleRendering#getSpecularColour Specular Colour}' reference.
	 * 
	 * 
	 * @param value the new value of the 'Specular Colour' reference.
	 * @see #isSetSpecularColour()
	 * @see #unsetSpecularColour()
	 * @see #getSpecularColour()
	 * @generated
	 */
	void setSpecularColour(IfcColourOrFactor value);

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcSurfaceStyleRendering#getSpecularColour Specular Colour}' reference.
	 * 
	 * 
	 * @see #isSetSpecularColour()
	 * @see #getSpecularColour()
	 * @see #setSpecularColour(IfcColourOrFactor)
	 * @generated
	 */
	void unsetSpecularColour();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcSurfaceStyleRendering#getSpecularColour Specular Colour}' reference is set.
	 * 
	 * 
	 * @return whether the value of the 'Specular Colour' reference is set.
	 * @see #unsetSpecularColour()
	 * @see #getSpecularColour()
	 * @see #setSpecularColour(IfcColourOrFactor)
	 * @generated
	 */
	boolean isSetSpecularColour();

	/**
	 * Returns the value of the 'Specular Highlight' reference.
	 * 
	 * 
	 * If the meaning of the 'Specular Highlight' reference isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Specular Highlight' reference.
	 * @see #isSetSpecularHighlight()
	 * @see #unsetSpecularHighlight()
	 * @see #setSpecularHighlight(IfcSpecularHighlightSelect)
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcSurfaceStyleRendering_SpecularHighlight()
	 * @model unsettable="true"
	 * @generated
	 */
	IfcSpecularHighlightSelect getSpecularHighlight();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc4.IfcSurfaceStyleRendering#getSpecularHighlight Specular Highlight}' reference.
	 * 
	 * 
	 * @param value the new value of the 'Specular Highlight' reference.
	 * @see #isSetSpecularHighlight()
	 * @see #unsetSpecularHighlight()
	 * @see #getSpecularHighlight()
	 * @generated
	 */
	void setSpecularHighlight(IfcSpecularHighlightSelect value);

	/**
	 * Unsets the value of the '{@link org.bimserver.models.ifc4.IfcSurfaceStyleRendering#getSpecularHighlight Specular Highlight}' reference.
	 * 
	 * 
	 * @see #isSetSpecularHighlight()
	 * @see #getSpecularHighlight()
	 * @see #setSpecularHighlight(IfcSpecularHighlightSelect)
	 * @generated
	 */
	void unsetSpecularHighlight();

	/**
	 * Returns whether the value of the '{@link org.bimserver.models.ifc4.IfcSurfaceStyleRendering#getSpecularHighlight Specular Highlight}' reference is set.
	 * 
	 * 
	 * @return whether the value of the 'Specular Highlight' reference is set.
	 * @see #unsetSpecularHighlight()
	 * @see #getSpecularHighlight()
	 * @see #setSpecularHighlight(IfcSpecularHighlightSelect)
	 * @generated
	 */
	boolean isSetSpecularHighlight();

	/**
	 * Returns the value of the 'Reflectance Method' attribute.
	 * The literals are from the enumeration {@link org.bimserver.models.ifc4.IfcReflectanceMethodEnum}.
	 * 
	 * 
	 * If the meaning of the 'Reflectance Method' attribute isn't clear,
	 * there really should be more of a description here...
	 * 
	 * 
	 * @return the value of the 'Reflectance Method' attribute.
	 * @see org.bimserver.models.ifc4.IfcReflectanceMethodEnum
	 * @see #setReflectanceMethod(IfcReflectanceMethodEnum)
	 * @see org.bimserver.models.ifc4.Ifc4Package#getIfcSurfaceStyleRendering_ReflectanceMethod()
	 * @model
	 * @generated
	 */
	IfcReflectanceMethodEnum getReflectanceMethod();

	/**
	 * Sets the value of the '{@link org.bimserver.models.ifc4.IfcSurfaceStyleRendering#getReflectanceMethod Reflectance Method}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Reflectance Method' attribute.
	 * @see org.bimserver.models.ifc4.IfcReflectanceMethodEnum
	 * @see #getReflectanceMethod()
	 * @generated
	 */
	void setReflectanceMethod(IfcReflectanceMethodEnum value);

} // IfcSurfaceStyleRendering