-/** Copyright (c) 2017 Samsung Electronics Co., Ltd.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-* http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
+/*
+ * Copyright(c) 2017 Samsung Electronics Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
namespace Tizen.NUI
{
+ /// <summary>
+ /// Geometry is handle to an object that can be used to define a geometric elements.
+ /// </summary>
public class Geometry : BaseHandle
{
private global::System.Runtime.InteropServices.HandleRef swigCPtr;
return (obj == null) ? new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero) : obj.swigCPtr;
}
+ /// <summary>
+ /// Dispose.
+ /// </summary>
+ /// <since_tizen> 3 </since_tizen>
protected override void Dispose(DisposeTypes type)
{
if (disposed)
base.Dispose(type);
}
+ /// <summary>
+ /// Create an instance of Geometry.
+ /// <since_tizen> 3 </since_tizen>
+ /// </summary>
public Geometry() : this(NDalicPINVOKE.Geometry_New(), true)
{
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Adds a PropertyBuffer to be used as source of geometry vertices.
+ /// </summary>
+ /// <param name="vertexBuffer">PropertyBuffer to be used as source of geometry vertices.</param>
+ /// <returns>Index of the newly added buffer.</returns>
+ /// <since_tizen> 3 </since_tizen>
public uint AddVertexBuffer(PropertyBuffer vertexBuffer)
{
uint ret = NDalicPINVOKE.Geometry_AddVertexBuffer(swigCPtr, PropertyBuffer.getCPtr(vertexBuffer));
return ret;
}
+ /// <summary>
+ /// Retrieves the number of vertex buffers that have been added to this geometry.
+ /// </summary>
+ /// <returns>Number of vertex buffers that have been added to this geometry.</returns>
+ /// <since_tizen> 3 </since_tizen>
public uint GetNumberOfVertexBuffers()
{
uint ret = NDalicPINVOKE.Geometry_GetNumberOfVertexBuffers(swigCPtr);
return ret;
}
+ /// <summary>
+ /// Removes a vertex buffer.
+ /// </summary>
+ /// <param name="index">Index to the vertex buffer to remove.</param>
+ /// <since_tizen> 3 </since_tizen>
public void RemoveVertexBuffer(uint index)
{
NDalicPINVOKE.Geometry_RemoveVertexBuffer(swigCPtr, index);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Sets a the index data to be used as a source of indices for the geometry
+ /// Setting this buffer will cause the geometry to be rendered using indices.
+ /// </summary>
+ /// <param name="indices">Array of indices.</param>
+ /// <param name="count">Number of indices in the array.</param>
+ /// <since_tizen> 3 </since_tizen>
public void SetIndexBuffer(ushort[] indices, uint count)
{
NDalicPINVOKE.Geometry_SetIndexBuffer(swigCPtr, indices, count);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
+ /// <summary>
+ /// Sets the type of primitives this geometry contains.
+ /// </summary>
+ /// <param name="geometryType">Array of indices.</param>
+ /// <since_tizen> 3 </since_tizen>
public void SetType(Geometry.Type geometryType)
{
NDalicPINVOKE.Geometry_SetType(swigCPtr, (int)geometryType);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
}
- public Geometry.Type GetType()
+ /// <summary>
+ /// Gets the type of primitives this geometry contains.
+ /// </summary>
+ /// <returns>Type of primitives this geometry contains.</returns>
+ /// <since_tizen> 3 </since_tizen>
+ public new Geometry.Type GetType()
{
Geometry.Type ret = (Geometry.Type)NDalicPINVOKE.Geometry_GetType(swigCPtr);
if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
return ret;
}
+ /// <summary>
+ /// Enumeration for the description of the type of geometry,
+ /// used to determine how the coordinates will be used.
+ /// </summary>
+ /// <returns>Type of primitives this geometry contains.</returns>
+ /// <since_tizen> 3 </since_tizen>
public enum Type
{
+ /// <summary>
+ /// Individual points.
+ /// </summary>
POINTS,
+
+ /// <summary>
+ /// Individual lines (made of 2 points each).
+ /// </summary>
LINES,
+
+ /// <summary>
+ /// A strip of lines (made of 1 point each) which also joins the first and last point.
+ /// </summary>
LINE_LOOP,
+
+ /// <summary>
+ /// A strip of lines (made of 1 point each).
+ /// </summary>
LINE_STRIP,
+
+ /// <summary>
+ /// Individual triangles (made of 3 points each).
+ /// </summary>
TRIANGLES,
+
+ /// <summary>
+ /// A fan of triangles around a centre point (after the first triangle, following triangles need only 1 point).
+ /// </summary>
TRIANGLE_FAN,
+
+ /// <summary>
+ /// A strip of triangles (after the first triangle, following triangles need only 1 point).
+ /// </summary>
TRIANGLE_STRIP
}
}
-}
+}
\ No newline at end of file
projects / platform / core / csapi / tizenfx.git / blobdiff