org.collada._2005._11.colladaschema
Class FxSurfaceCommon

java.lang.Object
  extended by org.collada._2005._11.colladaschema.FxSurfaceCommon
Direct Known Subclasses:
CgSurfaceType, GlslSurfaceType

public class FxSurfaceCommon
extends Object

The fx_surface_common type is used to declare a resource that can be used both as the source for texture samples and as the target of a rendering pass.

Java class for fx_surface_common complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="fx_surface_common">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <group ref="{http://www.collada.org/2005/11/COLLADASchema}fx_surface_init_common" minOccurs="0"/>
         <element name="format" type="{http://www.w3.org/2001/XMLSchema}token" minOccurs="0"/>
         <element name="format_hint" type="{http://www.collada.org/2005/11/COLLADASchema}fx_surface_format_hint_common" minOccurs="0"/>
         <choice minOccurs="0">
           <element name="size" type="{http://www.collada.org/2005/11/COLLADASchema}int3"/>
           <element name="viewport_ratio" type="{http://www.collada.org/2005/11/COLLADASchema}float2"/>
         </choice>
         <element name="mip_levels" type="{http://www.w3.org/2001/XMLSchema}unsignedInt" minOccurs="0"/>
         <element name="mipmap_generate" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element ref="{http://www.collada.org/2005/11/COLLADASchema}extra" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
       <attribute name="type" use="required" type="{http://www.collada.org/2005/11/COLLADASchema}fx_surface_type_enum" />
     </restriction>
   </complexContent>
 </complexType>
 


Field Summary
protected  List<Extra> extra
           
protected  String format
           
protected  FxSurfaceFormatHintCommon formatHint
           
protected  Object initAsNull
           
protected  Object initAsTarget
           
protected  FxSurfaceInitCubeCommon initCube
           
protected  List<FxSurfaceInitFromCommon> initFrom
           
protected  FxSurfaceInitPlanarCommon initPlanar
           
protected  FxSurfaceInitVolumeCommon initVolume
           
protected  Long mipLevels
           
protected  Boolean mipmapGenerate
           
protected  List<Long> size
           
protected  String type
           
protected  List<Double> viewportRatio
           
 
Constructor Summary
FxSurfaceCommon()
           
 
Method Summary
 List<Extra> getExtra()
          Gets the value of the extra property.
 String getFormat()
          Gets the value of the format property.
 FxSurfaceFormatHintCommon getFormatHint()
          Gets the value of the formatHint property.
 Object getInitAsNull()
          Gets the value of the initAsNull property.
 Object getInitAsTarget()
          Gets the value of the initAsTarget property.
 FxSurfaceInitCubeCommon getInitCube()
          Gets the value of the initCube property.
 List<FxSurfaceInitFromCommon> getInitFrom()
          Gets the value of the initFrom property.
 FxSurfaceInitPlanarCommon getInitPlanar()
          Gets the value of the initPlanar property.
 FxSurfaceInitVolumeCommon getInitVolume()
          Gets the value of the initVolume property.
 Long getMipLevels()
          Gets the value of the mipLevels property.
 List<Long> getSize()
          Gets the value of the size property.
 String getType()
          Gets the value of the type property.
 List<Double> getViewportRatio()
          Gets the value of the viewportRatio property.
 Boolean isMipmapGenerate()
          Gets the value of the mipmapGenerate property.
 void setFormat(String value)
          Sets the value of the format property.
 void setFormatHint(FxSurfaceFormatHintCommon value)
          Sets the value of the formatHint property.
 void setInitAsNull(Object value)
          Sets the value of the initAsNull property.
 void setInitAsTarget(Object value)
          Sets the value of the initAsTarget property.
 void setInitCube(FxSurfaceInitCubeCommon value)
          Sets the value of the initCube property.
 void setInitPlanar(FxSurfaceInitPlanarCommon value)
          Sets the value of the initPlanar property.
 void setInitVolume(FxSurfaceInitVolumeCommon value)
          Sets the value of the initVolume property.
 void setMipLevels(Long value)
          Sets the value of the mipLevels property.
 void setMipmapGenerate(Boolean value)
          Sets the value of the mipmapGenerate property.
 void setType(String value)
          Sets the value of the type property.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

initAsNull

protected Object initAsNull

initAsTarget

protected Object initAsTarget

initCube

protected FxSurfaceInitCubeCommon initCube

initVolume

protected FxSurfaceInitVolumeCommon initVolume

initPlanar

protected FxSurfaceInitPlanarCommon initPlanar

initFrom

protected List<FxSurfaceInitFromCommon> initFrom

format

protected String format

formatHint

protected FxSurfaceFormatHintCommon formatHint

size

protected List<Long> size

viewportRatio

protected List<Double> viewportRatio

mipLevels

protected Long mipLevels

mipmapGenerate

protected Boolean mipmapGenerate

extra

protected List<Extra> extra

type

protected String type
Constructor Detail

FxSurfaceCommon

public FxSurfaceCommon()
Method Detail

getInitAsNull

public Object getInitAsNull()
Gets the value of the initAsNull property.

Returns:
possible object is Object

setInitAsNull

public void setInitAsNull(Object value)
Sets the value of the initAsNull property.

Parameters:
value - allowed object is Object

getInitAsTarget

public Object getInitAsTarget()
Gets the value of the initAsTarget property.

Returns:
possible object is Object

setInitAsTarget

public void setInitAsTarget(Object value)
Sets the value of the initAsTarget property.

Parameters:
value - allowed object is Object

getInitCube

public FxSurfaceInitCubeCommon getInitCube()
Gets the value of the initCube property.

Returns:
possible object is FxSurfaceInitCubeCommon

setInitCube

public void setInitCube(FxSurfaceInitCubeCommon value)
Sets the value of the initCube property.

Parameters:
value - allowed object is FxSurfaceInitCubeCommon

getInitVolume

public FxSurfaceInitVolumeCommon getInitVolume()
Gets the value of the initVolume property.

Returns:
possible object is FxSurfaceInitVolumeCommon

setInitVolume

public void setInitVolume(FxSurfaceInitVolumeCommon value)
Sets the value of the initVolume property.

Parameters:
value - allowed object is FxSurfaceInitVolumeCommon

getInitPlanar

public FxSurfaceInitPlanarCommon getInitPlanar()
Gets the value of the initPlanar property.

Returns:
possible object is FxSurfaceInitPlanarCommon

setInitPlanar

public void setInitPlanar(FxSurfaceInitPlanarCommon value)
Sets the value of the initPlanar property.

Parameters:
value - allowed object is FxSurfaceInitPlanarCommon

getInitFrom

public List<FxSurfaceInitFromCommon> getInitFrom()
Gets the value of the initFrom property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the initFrom property.

For example, to add a new item, do as follows:

    getInitFrom().add(newItem);
 

Objects of the following type(s) are allowed in the list FxSurfaceInitFromCommon


getFormat

public String getFormat()
Gets the value of the format property.

Returns:
possible object is String

setFormat

public void setFormat(String value)
Sets the value of the format property.

Parameters:
value - allowed object is String

getFormatHint

public FxSurfaceFormatHintCommon getFormatHint()
Gets the value of the formatHint property.

Returns:
possible object is FxSurfaceFormatHintCommon

setFormatHint

public void setFormatHint(FxSurfaceFormatHintCommon value)
Sets the value of the formatHint property.

Parameters:
value - allowed object is FxSurfaceFormatHintCommon

getSize

public List<Long> getSize()
Gets the value of the size property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the size property.

For example, to add a new item, do as follows:

    getSize().add(newItem);
 

Objects of the following type(s) are allowed in the list Long


getViewportRatio

public List<Double> getViewportRatio()
Gets the value of the viewportRatio property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the viewportRatio property.

For example, to add a new item, do as follows:

    getViewportRatio().add(newItem);
 

Objects of the following type(s) are allowed in the list Double


getMipLevels

public Long getMipLevels()
Gets the value of the mipLevels property.

Returns:
possible object is Long

setMipLevels

public void setMipLevels(Long value)
Sets the value of the mipLevels property.

Parameters:
value - allowed object is Long

isMipmapGenerate

public Boolean isMipmapGenerate()
Gets the value of the mipmapGenerate property.

Returns:
possible object is Boolean

setMipmapGenerate

public void setMipmapGenerate(Boolean value)
Sets the value of the mipmapGenerate property.

Parameters:
value - allowed object is Boolean

getExtra

public List<Extra> getExtra()
Gets the value of the extra property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the extra property.

For example, to add a new item, do as follows:

    getExtra().add(newItem);
 

Objects of the following type(s) are allowed in the list Extra


getType

public String getType()
Gets the value of the type property.

Returns:
possible object is String

setType

public void setType(String value)
Sets the value of the type property.

Parameters:
value - allowed object is String

CroftSoft Javadoc

CroftSoft COLLADA JAXB Javadoc (2006-11-13 15:08:25)